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

Doc: pypesto.select xrefs + add select.postprocessors #1146

Merged
merged 3 commits into from
Oct 24, 2023

Conversation

dweindl
Copy link
Member

@dweindl dweindl commented Oct 23, 2023

Fixes formatting, adds proper cross-references, and add pypesto.select.postprocessors to the sphinx API doc.

👀 https://pypesto--1146.org.readthedocs.build/en/1146/api/pypesto.select.postprocessors.html

Fixes formatting, adds proper cross-references, and add pypesto.select.postprocessors to the sphinx API doc.
@dweindl dweindl requested review from dilpath and a team as code owners October 23, 2023 11:38
@codecov-commenter
Copy link

codecov-commenter commented Oct 23, 2023

Codecov Report

Merging #1146 (de8960f) into develop (160c2a8) will decrease coverage by 3.80%.
Report is 399 commits behind head on develop.
The diff coverage is 87.95%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@             Coverage Diff             @@
##           develop    #1146      +/-   ##
===========================================
- Coverage    88.16%   84.37%   -3.80%     
===========================================
  Files           79      148      +69     
  Lines         5257    11645    +6388     
===========================================
+ Hits          4635     9825    +5190     
- Misses         622     1820    +1198     
Files Coverage Δ
pypesto/C.py 100.00% <100.00%> (ø)
pypesto/__init__.py 100.00% <100.00%> (ø)
pypesto/engine/__init__.py 100.00% <100.00%> (ø)
pypesto/engine/multi_process.py 93.10% <100.00%> (+0.79%) ⬆️
pypesto/engine/multi_thread.py 100.00% <100.00%> (ø)
pypesto/engine/single_core.py 100.00% <100.00%> (ø)
pypesto/engine/task.py 100.00% <100.00%> (ø)
pypesto/ensemble/__init__.py 100.00% <100.00%> (ø)
pypesto/ensemble/task.py 100.00% <100.00%> (ø)
pypesto/hierarchical/__init__.py 100.00% <100.00%> (ø)
... and 138 more

Copy link
Collaborator

@PaulJonasJost PaulJonasJost left a comment

Choose a reason for hiding this comment

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

Thanks for this, do you think we need to do this at one point for other modules as well?

Copy link
Member

@dilpath dilpath left a comment

Choose a reason for hiding this comment

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

Thanks a lot! For some reason pathlib.Path is documented as pypesto.select.postprocessors.Path on RTD. I still need to go over the docs and fill in missing docstrings etc., so this can be left to another PR.

https://pypesto--1146.org.readthedocs.build/en/1146/api/pypesto.select.postprocessors.html#pypesto.select.postprocessors.Path

@dweindl
Copy link
Member Author

dweindl commented Oct 24, 2023

do you think we need to do this at one point for other modules as well?

At some point, yes. Not a priority.

For some reason pathlib.Path is documented as pypesto.select.postprocessors.Path

Resolved.

@dweindl dweindl merged commit f71b006 into develop Oct 24, 2023
18 checks passed
@dweindl dweindl deleted the doc_select_postprocess branch October 24, 2023 06:08
This was referenced Nov 15, 2023
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.

4 participants