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.

Sign up for GitHub

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

Jump to bottom

DOC: Add replacement NEP links in superseded, replaced-by fields #26320

Merged
merged 3 commits into from Apr 23, 2024
Merged

DOC: Add replacement NEP links in superseded, replaced-by fields #26320

merged 3 commits into from Apr 23, 2024

Conversation

arunppsg
Copy link
Contributor

Fixes #25930

Summary of changes:

  • add nep references to replaced by and replaces tags in superseded neps
  • use regex expression parse nep ids for building tags from the new format of replaced-by and replaces tags

@mattip
Copy link
Member

mattip commented Apr 21, 2024

Thanks. This seems to work "as advertised" and creates the proper index and links. Is it worth mentioning how to do this in the future in the "superceded" section of NEP 00?

numpy/doc/neps/nep-0000.rst

Lines 147 to 149 in 552fdd4

NEPs can also be ``Superseded`` by a different NEP, rendering the
original obsolete. The ``Replaced-By`` and ``Replaces`` headers
should be added to the original and new NEPs respectively.

@arunppsg
Copy link
Contributor Author

Makes sense, added example in 46d7293

@mattip mattip merged commit f8392ce into numpy:main Apr 23, 2024
63 of 65 checks passed
@mattip
Copy link
Member

mattip commented Apr 23, 2024

Thanks @arunppsg

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
04 - Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make "Replaced-By" and "Replaces" metadata in NEPs render as links
2 participants
@arunppsg @mattip