Documentation: ellipsis or dot dot dot?
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 11.9k
- Forks
- 1.5k
- Avg merge
- 17h 55m
- Merged PRs (30d)
- 3
Description
At: https://shopify.github.io/liquid/filters/truncate/
Documentation states:
If the specified number of characters is less than the length of the string, an ellipsis (…) is appended to the string and is included in the character count.
and gives a contradictory example:
Ground control to...
This is a contradiction because the former is an ellipsis and the latter is three periods.
PR coming
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 truncate filter documentation page linked in the issue and compare the statement about the ellipsis with the “Ground control to...” example. Update the documentation so the terminology and example are consistent, then verify that the character-count explanation remains accurate.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100