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

Better round tripping for See also section #189

Closed
wants to merge 1 commit into from

Conversation

hmaarrfk
Copy link
Contributor

Potential Fix for #188

@pv
Copy link
Member

pv commented Aug 12, 2018

-1, they are meant to become links, and this breaks SphinxDocString behavior.

I'm not exactly sure if what you are trying to achieve aligns with numpydoc goals.
In particular, round-tripping the docstrings is not a design goal for numpydoc.

@pv pv closed this Aug 12, 2018
@hmaarrfk
Copy link
Contributor Author

ok

@hmaarrfk
Copy link
Contributor Author

@pv, could it be provided as an additional function? There has been some interest in having wrapper modify the docstrings:

#67 (comment)

Something I wrote:
https://github.com/hmaarrfk/deprecation_factory/blob/cfe72994e991e9833b7084419d5341139a6da97b/deprecation_factory/default_parameter_change.py#L146

Having the ability to roundtrip docstrings would be useful in these cases.

@pv
Copy link
Member

pv commented Aug 12, 2018

Changes in SphinxDocString.__str__ output generally should make sure the changes in the output do not cause regressions in how the documentation is formatted by Sphinx.

There's more freedom in changing what NumpyDocString.__str__ outputs, as that is not used in the documentation output. If you want to make that to round-trip, that's in principle possible, but note that the implementation is often entangled with SphinxDocString.__str__.

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.

2 participants