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

Remove class title underline from operator template #1985

Merged
merged 1 commit into from
Jan 6, 2025

Conversation

PProfizi
Copy link
Contributor

@PProfizi PProfizi commented Jan 2, 2025

Following changes made to fix problems in the API documentation.

As mentioned here, changes were made directly to the operator modules despite them being generated automatically upon server sync. This currently creates merge conflicts in the server sync pipeline (see here and conflicting files here).
This PR removes the conflict by updating the template used when generating the modules so they match with the expected format.

Following changes made to fix problems in the API documentation.
@PProfizi PProfizi added the CI/CD Related to CI/CD label Jan 2, 2025
@PProfizi PProfizi requested review from jorgepiloto and moe-ad January 2, 2025 15:52
@PProfizi PProfizi self-assigned this Jan 2, 2025
@PProfizi PProfizi added bug Something isn't working and removed CI/CD Related to CI/CD labels Jan 2, 2025
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 2, 2025
@PProfizi
Copy link
Contributor Author

PProfizi commented Jan 2, 2025

@moe-ad @jorgepiloto how should I mark the operators modules (everything under a folder in src/ansys/dpf/core/operators) as not to be edited directly?
I can mark them as requiring approval from maintainers as it is done for src/ansys/dpf/gate/ or src/ansys/grpc/dpf yet that is not exactly the same thing. It will only allow maintainers to spot this and tell the developer not to do that.

Copy link

codecov bot commented Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.42%. Comparing base (b7f89f7) to head (a051694).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1985   +/-   ##
=======================================
  Coverage   88.41%   88.42%           
=======================================
  Files          89       89           
  Lines       10258    10251    -7     
=======================================
- Hits         9070     9064    -6     
+ Misses       1188     1187    -1     

@moe-ad
Copy link
Contributor

moe-ad commented Jan 2, 2025

Hello @PProfizi. Welcome back! Thanks for identifying this.
Regarding your question, we can add a pre-commit hook that will not allow commits containing changes to that directory by any author/committer other than the one configured for the CI action that automatically generates those files.
Maybe @jorgepiloto can also have a different suggestion.

Copy link
Contributor

@moe-ad moe-ad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@moe-ad moe-ad merged commit 2f94493 into master Jan 6, 2025
44 checks passed
@moe-ad moe-ad deleted the doc/fix_operator_header_title_underline branch January 6, 2025 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants