realpython / realpython/python-guide
Ambiguity in the Structure section.
Open
Nobody has claimed this yet.
- Dominant language
- Batchfile
- Stars
- 29.8k
- Forks
- 5.9k
- PR merge metrics
- No merged PRs in 30d
Description
I'm a little confused as to what this passage from writing/structure means.
Readability means to avoid useless boilerplate text and clutter,
therefore some efforts are spent trying to achieve a certain level of brevity.
But terseness and obscurity are the limits where brevity should stop.
Could this be reworded as something like this?
Readability in this case refers to avoiding useless boilerplate text and
clutter, and some effort has been made to achieve a certain level of brevity
in Python's syntax. However, there is a fine line between terseness and
obscurity.
I'm not sure I'm correctly grasping the meaning of the text. Does it actually mean something completely different?
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 at the Modules section of docs/writing/structure.rst, using the linked passage as the scope. Confirm the intended meaning with the existing discussion, then revise the wording only if that meaning is clear; done means the rendered passage is unambiguous and preserves the original guidance.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100