simonsobs / simonsobs/so_dev_guide
Wrapping
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
In the current draft, the plain-text documentation specifies: "Wrap paragraphs at 80 characters."
I would advocate for all code, not just documentation, being wrapped at 80 characters, for two reasons:
- You can easily view code on standard terminals with
lessorvimwithout confusing wrapping. (Even if I'm the only person on the team that codes invim, others may want to look something up usinglessorcator similar.) - It is one way to discourage lots of nested indents.
Contributor guide
No contributing guide indexed for this repository
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 with the current plain-text documentation draft referenced in the issue and review how its 80-character paragraph rule is expressed. Decide how the rule should apply to code, then update the guide so the 80-character expectation is explicit and consistent for both documentation and code.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100