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

Add versionremoved directive #11905

Merged
merged 4 commits into from Jan 21, 2024
Merged

Conversation

hugovk
Copy link
Contributor

@hugovk hugovk commented Jan 21, 2024

Feature or Bugfix

  • Feature

Purpose

  • Add versionremoved directive, for when removing features.
  • Similar to existing versionadded, versionchanged, and deprecated.

Relates

Copy link
Contributor

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a maintainer here ofc, and personally I'm working on a suite of much more capable directives to replace the upstream builtin version* suite with CPython's deprecated-removed as a basis (which more or less already replaces this), but it seems eminently sensible and straightforward, IMO, to add a versionremoved to the base suite to parallel the others. A few minor comments.

doc/usage/restructuredtext/directives.rst Outdated Show resolved Hide resolved
tests/roots/test-intl/versionchange.txt Outdated Show resolved Hide resolved
doc/usage/builders/index.rst Outdated Show resolved Hide resolved
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
hugovk and others added 2 commits January 21, 2024 12:14
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@AA-Turner AA-Turner merged commit 95b2cce into sphinx-doc:master Jan 21, 2024
22 checks passed
@AA-Turner
Copy link
Member

Thanks!

@hugovk hugovk deleted the add-versionremoved branch January 21, 2024 20:18
@CAM-Gerlach
Copy link
Contributor

Thanks @AA-Turner !

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add versionremoved directive to complement versionadded and deprecated
4 participants