Skip to content

[Doc]: document provisional flag in API guidelines #32044

Description

@story645

Documentation Link

https://matplotlib.org/devdocs/devel/api_changes.html

Problem

Noticed in #31162 that we don't have any guidelines for when/how to label API as provisional, but I think it comes up in review/api discussion enough that we should at least document it.

Suggested improvement

Add a section to API guidelines explaining the usage of the provisional status: when to flag API as provisional, how to document provisional status, how long the status should stay provisional, etc.

NOTE: This PR should probably be implemented by a maintainer because the work here is in writing up the institutional/tacit knowledge of what provisional means in the Matplotlib API context.

Metadata

Metadata

Assignees

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions