Poorly worded repeated capabilities documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
While working on #1290, a comment about how the repeated capabilities text in documentation was poor:
.. py:attribute:: nidigital.Session.sites[]
If no prefix is added to the items in the parameter, the correct prefix will be added when
the driver function call is made.
This phrase implies that the user knows about the underlying C API and describes an implementation detail.
Python users should not need to know nor care nor have us confuse them with hthis. I'd even argue that if documentation just told them how to use the basic tuple of numbers way we'd be fine.
Also:
session.sites[0,1].channel_enabled = True
The above would be more "Pythonic"
And:
passes a string of :python:`'site0, site1, site2'` to the set attribute function.
If an invalid repeated capability is passed to the driver, the driver will return an error.
You can also explicitly use the prefix as part of the parameter, but it must be the correct prefix
for the specific repeated capability.
I'd get rid of all this. It's good for the contributor to know but not for the user.
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 searching the documentation for the nidigital.Session.sites[] attribute and the repeated-capability passages quoted here, then review the context from issue #1290. Done means the user-facing text explains Python usage without underlying C API or driver implementation details, with consistent repeated-capability examples.
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
- 42/100