Skip to content

.. versionchanged:: directives #1683

Open
1 of 1 issue completed
Open

Description

@niccokunzmann

When contributions are made, it is unclear into which version they are going: a new major, minor or patch release?

We have a release process that would very well accommodate making documentation of version changes flexible.

Proposal

(1) Whenever a .. versionchanged:: directive (or similar) is added, add it as

..  versionchanged:: 0.0.0

(2) In the release process, we add a make command that updates the docs to the respective version. (one-line sed command could do it)

Implementation

See also

@stevepiercy What are your thoughts on this?

Activity

  1. stevepiercy commented on Aug 18, 2026

    @stevepiercy
    Member

    0.0.0 is a good token for the regular expression, as long as it doesn't mangle src/icalendar/version.py.

    The regular expression should accommodate any version* or deprecated directive, and not care about spaces. Both of these should be acceptable.

    ..  version-deprecated:: 0.0.0
    .. version-deprecated:: 0.0.0
    
  2. Solaris-star commented on Aug 19, 2026

    @Solaris-star
    Contributor

    I’m taking the first implementation slice from this issue as one atomic change: normalize unreleased version*/deprecated Sphinx directive versions in the documentation to 0.0.0, without touching src/icalendar/version.py. I’ll preserve the directive’s flexible spacing, add the required change-log entry and regression coverage where appropriate, and run the repository’s relevant checks before opening a PR. The release-time make changes automation will remain a separate follow-up.

  3. niccokunzmann commented on Aug 19, 2026

    @niccokunzmann
    MemberAuthor

    @Solaris-star Thank you! I am looking forward to your PR!

  4. niccokunzmann commented on Aug 20, 2026

    @niccokunzmann
    MemberAuthor

    @Solaris-star #1699 Should now cover this first part.

  5. added
    NLnetIssues and pull requests that qualify for NLnet funding.
    on Aug 23, 2026
  6. added this to the 8.0.0 milestone on Oct 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    NLnetIssues and pull requests that qualify for NLnet funding.doc

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions