forked from apdavison/fairgraph
-
Notifications
You must be signed in to change notification settings - Fork 10
Document a deprecation policy #122
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationtaskMaintenance, reduction of technical debt, software quality improvements, etc.Maintenance, reduction of technical debt, software quality improvements, etc.
Milestone
Description
Activity
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationtaskMaintenance, reduction of technical debt, software quality improvements, etc.Maintenance, reduction of technical debt, software quality improvements, etc.
The codebase carries several deprecated aliases that emit
DeprecationWarning—Field(fairgraph/fields.py), thefields/field_names/required_field_names/existence_query_fieldsclassmethods andNode(registry.py),RepresentsSingleObject(base.py),EmbeddedMetadata(embedded.py), and thescopekeyword (utility.py).What is missing is the policy: which names are deprecated, when each was deprecated, and in which release it will be removed. The
scopekeyword's warning already promises removal "in version 1.0", so the intent exists but is scattered across warning strings.A table in the documentation would make the contract legible, and gives users something to plan against.