Explicitly define public API with `__all__`

Open
#958 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
api

Research direction

Start by reviewing the cf-python package modules and docs/source/check_docs_api_coverage.py to understand which names are treated as public and how API coverage is checked. Define the intended public names consistently across the codebase, then verify that the documentation coverage script can use the declarations as its canonical source.

Written by the indexing model from the issue text.

Description

API review (4.0.0) documentation

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.

Dominant language
Python
Stars
150
Forks
23
Avg merge
1d 11h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from NCAS-CMS/cf-python

All issues in NCAS-CMS/cf-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.