Skip to content

Examples from the cheat sheet #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 40 commits into from
Apr 14, 2025
Merged

Examples from the cheat sheet #283

merged 40 commits into from
Apr 14, 2025

Conversation

jgd10
Copy link
Contributor

@jgd10 jgd10 commented Apr 3, 2025

The pydynamic reporting cheat sheet (e.g. https://developer.ansys.com/blog/pydynamicreporting-cheat-sheet) contains several snippets of code that don't otherwise appear as examples in the docs. This means they won't appear in searches. Some shorter, simpler, examples would help improve the docs as well.

As a consequence of this I have been working on splitting this cheat sheet into constituent basic examples.

So far I have created 3. I can continue adding the rest to this PR (I should end up with ~7-9 in total) or they can come in separate PRs if that is preferred.

Pydynamicreporting is not my area of expertise so suggestions on how the examples can be improved would be welcome.

@jgd10 jgd10 requested a review from randallfrank April 3, 2025 18:03
@jgd10 jgd10 requested a review from margalva April 4, 2025 10:34
@jgd10 jgd10 added the documentation Improvements or additions to documentation label Apr 4, 2025
@codecov-commenter
Copy link

codecov-commenter commented Apr 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.86%. Comparing base (2cf7b70) to head (1aa7909).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #283   +/-   ##
=======================================
  Coverage   75.86%   75.86%           
=======================================
  Files          25       25           
  Lines        7027     7027           
  Branches     1335     1335           
=======================================
  Hits         5331     5331           
  Misses       1248     1248           
  Partials      448      448           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@margalva
Copy link
Collaborator

margalva commented Apr 11, 2025

@jgd10 I've pushed a few changes to this branch - hope it's ok. Let me know your comments.
I'll add some other pydynamicreporting member to be the reviewer as I've made changes to the PR code.

@jgd10
Copy link
Contributor Author

jgd10 commented Apr 11, 2025 via email

jgd10 and others added 14 commits April 11, 2025 15:42
@margalva
Copy link
Collaborator

@jgd10 minor fixes and eliminate a file that was a duplicate.
Looks good to go for me know. Thank you for all your work!

@jgd10 jgd10 merged commit beb43b9 into main Apr 14, 2025
19 checks passed
@jgd10 jgd10 deleted the Doc/examples_from_cheatsheet branch April 14, 2025 09:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants