-
Notifications
You must be signed in to change notification settings - Fork 18
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedExtra attention is neededExtra attention is neededpythonPull requests that update Python codePull requests that update Python code
Description
Problem
A number of the Python docstrings which generate our Python Sphinx docs are out of date, missing parameters or non-existent.
Proposed Solution
Update the docstrings to add and improve the Python documentation. This will be done over several separate PRs, with Open Source contributions being very welcome.
- As part of this, we should switch the
backend/Dockerfile
(andto pull in the latest local version of the python bailo clientbackend/Dockerfile.dev
until Collapse Dockerfile.dev into single Dockerfile per service #2447 is merged)/lib/python
rather than building the most recently published version on PyPI. This means that any forks that modify the python client will include their own version of the docs, rather than our version.
Covered by Make docker-compose backend build docs for the local python version #2454 - Python
core
docs
Covered by Add and improve bailo core docs #2456 - Python
helper
docs
Covered by Add and improve python helper docstrings #2483 - backend notebooks
Covered by Improve python notebook docs #2582 - Align Python README with updated feature set
Alternatives
n/a
What is the priority of your issue?
Low
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedExtra attention is neededExtra attention is neededpythonPull requests that update Python codePull requests that update Python code