sphinx-doc / sphinx-doc/sphinx
docs: Avoid unclear use of "attribute"
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
The documentation of the missing-reference event says that the pending_xref node has "attributes reftype, reftarget...". However, these are not Python instance attributes - they are accessed with node["reftype"], not node.reftype.
I suggest referring to these fields as "items" rather than "attributes" to match the syntax used for accessing them. (I'm not sure if this is a general problem throughout the docs or if it's just here on missing-reference). Also, there's a typo here - the word "attributes" is repeated both before and after the list of names.
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
Open the linked missing-reference event documentation and inspect the sentence describing the pending_xref node fields. Change the wording so the listed fields are called items rather than attributes, remove the repeated “attributes” typo, and verify the rendered documentation conveys the intended terminology.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 78/100