Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Enforce the use ofdeprecated-removed in docs #92564

Open
Labels
3.10only security fixes3.11only security fixes3.12only security fixes3.9 (EOL)end of lifedocsDocumentation in the Doc dirtype-featureA feature request or enhancement
@ezio-melotti

Description

@ezio-melotti

In the docs we have two directives that can be used todocument deprecations:deprecated anddeprecated-removed.

I think we should always prefer the latter:

  • it will make it easier to track and document removals
  • it will give people a target, so they can plan around it

Even if the removal version gets postponed, it's better to postpone than to say that something is deprecated and then just remove it at an unspecified time in the future.

Currentlydeprecated is more commonly used:

$ grep -r 'deprecated::' --include=*.rst | wc -l226$ grep -r 'deprecated-removed::' --include=*.rst | wc -l30

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.10only security fixes3.11only security fixes3.12only security fixes3.9 (EOL)end of lifedocsDocumentation in the Doc dirtype-featureA feature request or enhancement

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


      [8]ページ先頭

      ©2009-2025 Movatter.jp