Inconsistencies and Holes in with Grammar documentation
@soutaro is already working on this.
Since Nov 20, 2023.
- Dominant language
- Ruby
- Stars
- 2.2k
- Forks
- 256
- Avg merge
- 6d 17h
- Merged PRs (30d)
- 37
Description
I found three issues with the syntax documentation
-
proc is inconsistent
In the "Types" section, proc's grammar is laid out as
But in the "Method Types" section, proc's grammar is laid out as
I believe the bottom one is correct, so we should change the first one to be accurate -
record-name, members are undefined
As the header states, record-name and members are used several times but not defined in the document. -
inconsistency in representing repetition
The document sometimes uses "etc." in the beginning and "..." towards the end to represent repeating 1 or more times. This is confusing from the reader. Also, there may be a typo that stems from this inconsistent use. For example, method-name's definition uses no quotes ... when I believe the intention is to say "..."
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.
Assessment
This issue has not been assessed yet.