Skip to content

Conversation

AnsMelanie
Copy link
Contributor

@AnsMelanie AnsMelanie commented Aug 7, 2025

Take into account operator description updates in MD files named with the _upd suffix, such as op-name_upd.md.
Such files should only contain a section ## Description.

…in another MD file op-name_upd.md. This file should contain a section ## Description
@AnsMelanie AnsMelanie requested a review from PProfizi August 7, 2025 13:23
Copy link

codecov bot commented Aug 7, 2025

Codecov Report

❌ Patch coverage is 90.47619% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.28%. Comparing base (1e18868) to head (682e74e).
⚠️ Report is 2 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #2533       +/-   ##
===========================================
+ Coverage   46.34%   84.28%   +37.93%     
===========================================
  Files          92       92               
  Lines       10819    10855       +36     
===========================================
+ Hits         5014     9149     +4135     
+ Misses       5805     1706     -4099     

@PProfizi
Copy link
Contributor

PProfizi commented Sep 19, 2025

Conclusion of discussion in meeting:
Change to an update of generate_operators_doc.py as an additional step during doc source generation.

-> generate_operators_doc.py must generate the Markdown sources as used on the Developer Portal.

@PProfizi PProfizi changed the title Created a script to udpate operator description with the description … feat: support "update" files for operator descriptions during operator documentation generation Sep 30, 2025
Copy link
Contributor

github-actions bot commented Oct 1, 2025

Some tests with 'continue-on-error: true' have failed:

  • PyDPF-Post API tests on ubuntu-latest

Created by continue-on-error-comment

@PProfizi PProfizi merged commit df5dd9b into main Oct 1, 2025
44 of 45 checks passed
@PProfizi PProfizi deleted the AnsMelanie/op-doc/update-description branch October 1, 2025 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants