Skip to content
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

Examples from the cheat sheet #283

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

jgd10
Copy link

@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 74.09%. Comparing base (e3fabf9) to head (37b79a1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #283   +/-   ##
=======================================
  Coverage   74.09%   74.09%           
=======================================
  Files          25       25           
  Lines        7019     7019           
  Branches     1329     1329           
=======================================
  Hits         5201     5201           
  Misses       1342     1342           
  Partials      476      476           

☔ 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.

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.

2 participants