Consistency in quote and possession marks
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 136
- Forks
- 555
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 4
Description
It looks like we have an implicit rule for quote and possession marks in this devdocs:
- Use ’
’ or ’for possession mark (in customer’s, shop’s) and not abbreviation (in isn’t, aren’t, doesn’t) - Use “ ”
“ ” or “ ”for string quote in Normal text - Use "
" or "and '' or 'for string quote in Code block
as we can see in the grid page https://devdocs.prestashop.com/8/development/components/grid/ and many other pages.
By the way, in some pages ' ' or ' is used for possession mark in Normal text, for example https://github.com/PrestaShop/docs/compare/8.x...leemyongpakvn:docs:8.x---possesion-mark
We need an explicit rule to keep Consistency in quote and possession marks, write it to https://devdocs.prestashop.com/8/contribute/ will be helpful.
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 contribute page at https://devdocs.prestashop.com/8/contribute/ and compare the quote and possession-mark examples on the grid page. Document the explicit rules for normal text and code blocks, including the relevant HTML entities; done means the guidance is published on the contribute page.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100