Module 02: cover the underscore-prefix 'private/internal' convention
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
Start in 02_function_classes.qmd around the naming-conventions section and review the existing mikeio.pfs._pfssection.PfsSection example. Add the underscore-prefix, all, re-exporting, and double-underscore guidance, then update the Breaking changes slide in 07_packaging.qmd with the public-API qualification and a cross-reference. Done means both modules clearly connect internal-name conventions to versioning.
Written by the indexing model from the issue text.
Description
Module 02 (02_function_classes.qmd) teaches Python naming conventions but does not cover the leading-underscore convention for internal/private names. This came up in practice: a user upgraded a dependency, found that several _-prefixed functions had been removed, and was upset — not realising those were never part of the public API.
The breaking-changes slide in 07_packaging.qmd (Removing a function / Renaming / Changing signature → bump major) is the counterpart to this: removing a _private function is not a breaking change. Worth a forward reference between the two modules.
Suggested content for module 02
Add a slide near the existing naming-conventions section (around 02_function_classes.qmd:802) covering:
_foosignals internal — not part of the public API- Consumers who import underscore-prefixed names do so at their own risk
- Maintainers may change/remove them without bumping the major version
__all__in__init__.pyto declare the public surface- Re-exporting internals into the package namespace (the existing
mikeio.pfs._pfssection.PfsSectionexample at02_function_classes.qmd:795is a natural lead-in) - Double-underscore (
__name) name mangling is a separate thing — mention briefly to avoid confusion
Cross-reference
Update the "Breaking changes" slide in 07_packaging.qmd to note that the rules apply to the public API only, with a pointer back to module 02.
See PEP 8 — Naming Conventions / Public and internal interfaces.
- Dominant language
- Jupyter Notebook
- Stars
- 8
- Forks
- 1
- Avg merge
- 4m
- Merged PRs (30d)
- 1
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DHI/python-package-development
-
Difficulty 2/5 1-2 days Newbie friendliness 72/100
DHI/python-package-development#37 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
All issues in DHI/python-package-development
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
A11y ♿️
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Link Checker Report Openautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
documentation improve or update documentation priority/low triage
Difficulty 2/5 Half a day Newbie friendliness 86/100
warpdotdev/docs#782 · 1 comment ·