-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Preprocess other sections #8050
Conversation
c22866a
to
2c75aaa
Compare
I just noticed this doesn't work for Raises
------
MergeError
failed to merge
OtherError
description and napoleon_type_aliases = {
...
"MergeError": "~pandas.errors.MergeError",
"OtherError": ":py:exc:`~mypackage.OtherError",
...
} it should become :raises ~pandas.errors.MergeError: failed to merge
:raises ~mypackage.OtherError: description |
not sure if this is worth it, but this change makes sure roles are always stripped, even when they're around invalid names. That means we don't have to make the type preprocessor more complicated than it already is, with the disadvantage that it adds roles that will be stripped directly afterwards. Edit: tests will work after merging #8049 |
so now that #8049 is merged, the tests pass, too. Is there a reason why you scheduled this for 3.3.0? |
I don't have time for reviewing until release now. I have other topics for 3.2 release. Is this more important than others? |
not really, but it extends the type preprocessor to other fields ( If you're too busy I guess it's fine to push this to 3.3.0 |
Sorry for waiting. But I need to read the napoleon extension before reviewing because I'm a newbie of the module. So I need time for reviewing even for a minor fix. |
no worries. Also, thanks for the quick reviews on the other PRs. |
gentle ping, @tk0miya. Are there any updates on this? |
gentle ping, @tk0miya |
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.
LGTM!
Follow-up to #7690, depends on #8049. This enables the type processor for other sections (
Returns
,Yields
andRaises
, possibly more) and also adds tests.Turns out that the reason why I thought the previous PR didn't work was that I added the call to the preprocessor in the wrong place.
Related to #8004, but for
numpydoc
instead ofgoogle
.