Skip to content

Document a deprecation policy #122

Description

@apdavison

The codebase carries several deprecated aliases that emit DeprecationWarningField (fairgraph/fields.py), the fields/field_names/required_field_names/existence_query_fields classmethods and Node (registry.py), RepresentsSingleObject (base.py), EmbeddedMetadata (embedded.py), and the scope keyword (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 scope keyword'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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationtaskMaintenance, reduction of technical debt, software quality improvements, etc.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions