Skip to content

Explicitly define public API with __all__ #958

Description

@sadielbartholomew

We don't define the __all__ variable across the cf-python codebase, however we should because doing so has a number of benefits - through providing a single machine-readable source of truth for the API.

One, which I'll note (alone, otherwise see link above to benefits) because it relates to what I'm working on with #957 fixes, is to allow us to know canonically what should be present in the documentation, for example for our API coverage check script to use.

I'm labelling this also with 'API review (4.0.0)' because it can allow us to see more clearly the public API we have, facilitating review of it.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions