sphinx-doc / sphinx-doc/sphinx
[DOC] Should these words use hyphens or spaces and other spelling questions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
This is to ask for advice.
-
should "internet" be capitalized "Internet"
-
should it be "pickable" or "pickleable"?
-
should these words use an hyphen (or a space)? : autogenerates, autolinked, autonumbered, backend, backquote, dedent-ing, downtime, fallback, fallbacks, hardcoded, homepage, knowledgebase, lowlevel, markup, misdetect, misformatted, multibyte, multiline, nonbreaking, nonexisting, pagebreak, pagename, placeholder , plugin, postprocess, postprocessing, preprocesses, reindexed, reraised, standalone, subentry, testsetup, timezone, toolchain, typehint, walkthrough, website, whitespace.
This relates to #5865 and sums up all things I have not modified...
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 reviewing issue #5865 and the current documentation occurrences of the listed terms; no file or test is named in this issue. Done means reaching decisions on capitalization, spelling, and hyphenation and recording the agreed conventions in the relevant documentation.
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
- Needs clarification
- Newbie friendliness
- 25/100