-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
doc: add pandas and xarray fixtures to testing API docs #28879
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
Conversation
Does not render for some reason. |
it's rendered here, but getting lost: Was wondering if I should maybe add sample usage to the docstrings |
That's what I meant. For some reason autofunction does not produce content here. If nothing else helps, you could resort to a manual |
Theory: I suspect the reason is that You may try autodoc_mock_imports but I don't know whether that can mock decorators (if not you will still fail when the import ties to run the |
ee76ec4
to
cf4e812
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mock import works 👍
Was wondering if I should maybe add sample usage to the docstrings
This would be very helpful.
@story645 you can add the usage examples or merge immediately - as you see fit. |
I'm locally building the usage examples, will push in a bit |
3534879
to
291541a
Compare
I so don't understand how it's even more broken now |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Example" is not a numpydoc section. It's the plural https://numpydoc.readthedocs.io/en/latest/format.html#examples
Maybe this is tripping up numpydoc/autodoc?
how would you all feel about more pre-commits: https://numpydoc.readthedocs.io/en/latest/validation.html |
Well, it currently outputs a 27K-line table of issues on just the files in |
I know linting fix PRs aren't folks faves, but this seems like a good low hanging fruit task for sprints |
291541a
to
16d15c7
Compare
16d15c7
to
aeb40be
Compare
Co-authored-by: Tim Hoffmann <[email protected]>
aeb40be
to
dc3bdf5
Compare
Fine as long as the resulting PRs are trivial to review (small enough, only one kind of change at a time). I suspect the 27k-lines of issues contain a lot of aspects that we cannot or don't want to fulfill. I think you'd have to start with a |
…8879) Co-authored-by: Tim Hoffmann <[email protected]>
PR summary
Motivated by #28830, figured it'd be a lot easier for contributors to use/reviewers to suggest if the pandas and xarray fixtures were exposed in the docs. I'm not fond of the subheading title but also can't think of a better one.
PR checklist