Skip to content

Conversation

@PProfizi
Copy link
Contributor

@PProfizi PProfizi commented Nov 24, 2025

This PR updates the ansys.dpf.core.documentation package to integrate script usage examples for C++, IPython and CPython in the operator documentation for the DPF Framework documentation.

@PProfizi PProfizi requested a review from AnsMelanie November 24, 2025 15:25
@PProfizi PProfizi self-assigned this Nov 24, 2025
@PProfizi PProfizi added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 24, 2025
@PProfizi
Copy link
Contributor Author

Here is an example of how they render when I build the DPF Framework doc for 26R1 locally:

image

@PProfizi PProfizi requested a review from rafacanton November 24, 2025 15:29
@codecov
Copy link

codecov bot commented Nov 24, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.41%. Comparing base (b587c58) to head (573ff49).
⚠️ Report is 2 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2777   +/-   ##
=======================================
  Coverage   84.41%   84.41%           
=======================================
  Files          92       92           
  Lines       10944    10964   +20     
=======================================
+ Hits         9238     9255   +17     
- Misses       1706     1709    +3     

@PProfizi
Copy link
Contributor Author

PProfizi commented Nov 24, 2025

Here is an example PR on DevRelDocs using these changes (before I removed the empty C# examples)
https://github.com/ansys/DevRelDocs/pull/278/files

@PProfizi PProfizi requested a review from cbellot000 November 27, 2025 16:35
@PProfizi PProfizi merged commit dc9dfb5 into main Nov 27, 2025
86 of 87 checks passed
@PProfizi PProfizi deleted the feat/operator_doc_include_examples branch November 27, 2025 16:42
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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants