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

website: make "deprecation" more visible: red boxes #9478

Closed
nschloe opened this issue Jul 27, 2017 · 4 comments
Closed

website: make "deprecation" more visible: red boxes #9478

nschloe opened this issue Jul 27, 2017 · 4 comments

Comments

@nschloe
Copy link
Contributor

nschloe commented Jul 27, 2017

As discussed in #9475, numpy would likely profit from more visible deprecation notes than plain text in the docstring (see hstack's documentation, for example).

While actual deprecation is not desirable (for one, numpy 2.0 is a long way away), it was suggested to introduce big red boxes in the style of Python itself; see, e.g., here.

dep

@eric-wieser
Copy link
Member

eric-wieser commented Jul 27, 2017

Does .. deprecated: do the right thing here?

@nschloe
Copy link
Contributor Author

nschloe commented Jul 27, 2017

The function binary_repr has .. deprecated:: 1.12.0 set, but I see nothing of that in the generated docs.

corrcoef actually shows something in the docs, but it isn't very visible either.

@njsmith
Copy link
Member

njsmith commented Jul 27, 2017

It's fairly straightforward to redefine deprecated to be more visible, or to define a new directive, either by modifying the numpydoc plugin or by making a little numpy-local plugin.

@nschloe nschloe changed the title make "deprecation" more visible: red boxes website: make "deprecation" more visible: red boxes Dec 24, 2019
@seberg
Copy link
Member

seberg commented Nov 5, 2021

The deprecated directive now uses red boxes in the rendered docs.

@seberg seberg closed this as completed Nov 5, 2021
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

No branches or pull requests

4 participants