Skip to content

Conversation

@PProfizi
Copy link
Contributor

@PProfizi PProfizi commented Nov 3, 2025

Closes #2720
This removes usage of keywords Parameters and Returns as sections in the docstring of Python operator classes where the operator inputs and outputs are described.
This messed type propagation when instantiating an operator.

@PProfizi PProfizi requested a review from moe-ad November 3, 2025 17:54
@PProfizi PProfizi self-assigned this Nov 3, 2025
@PProfizi PProfizi added the bug Something isn't working label Nov 3, 2025
@codecov
Copy link

codecov bot commented Nov 3, 2025

Codecov Report

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2721   +/-   ##
=======================================
  Coverage   84.40%   84.41%           
=======================================
  Files          92       92           
  Lines       10899    10899           
=======================================
+ Hits         9199     9200    +1     
+ Misses       1700     1699    -1     

@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2025

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

  • PyDPF-Post API tests on ubuntu-latest

Created by continue-on-error-comment

@moe-ad moe-ad merged commit 359e852 into main Nov 4, 2025
86 of 87 checks passed
@moe-ad moe-ad deleted the fix/operator_classes_docstring_type_hints branch November 4, 2025 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rework docstrings of Python operator classes

4 participants