Skip to content

Improve description of towncrier apichange type #13793

@tsbinns

Description

@tsbinns

Problem

Changelog entries with the apichange type get description "API changes by deprecation", however this also encompasses API additions with no deprecations.

E.g., in the 1.11 changelog, the apichanges section shows the following:

Image

Only #13398 involves a deprecation; #13350 and #13458 involve only new parameters.

Proposed Solution

I think the description of apichange could be made more general, e.g., just "API changes".

Could also have separate types for API deprecations and API additions, but there are cases where the deprecation of something is accompanied by the addition of a replacement, so separating those two doesn't always make sense.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions