ni / ni/nisystemlink-clients-python
Several docs issues
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10
- Forks
- 32
- Avg merge
- 12h 42m
- Merged PRs (30d)
- 2
Description
I ran sphinx locally and noticed it outputs several warnings and errors. I didn't search thoroughly, but there are at least these problems:
-
SystemsClientis missing from the API reference because the autoclass is using the wrong module name (specsinstead ofsystems). -
Several APIs, at least asset and test monitor, use the incorrect indentation for parameter and exception docstrings such that they don't render correctly. For example, this line needs to be intended one more time to indicate it's a continuation rather than a new parameter. It gets rendered poorly:
I couldn't find any useful feedback from the readthedocs build report to flag these. I was able to run it locally by:
python -m venv docs\.venv
docs\.venv\Scripts\activate
python -m pip install --upgrade pip setuptools
python -m pip install -r docs\requirements.txt
python -m sphinx docs output
I don't know what poetry run poe doctest is supposed to do, but it doesn't work these days.
Contributor guide
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.
Research direction
Start by running the documented virtualenv and Sphinx commands, then inspect docs/api_reference/systems.rst and the referenced line in nisystemlink/clients/testmonitor/_test_monitor_client.py. Check the asset and test monitor API docstrings for the reported indentation issue and identify the remaining warnings and errors. Done means SystemsClient appears in the API reference and the affected documentation renders correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100