Proofreading of readme file + fix for issue #76 #86
Conversation
Committer: Shibatan <[email protected]> On branch add-shibatan Changes to be committed: modified: README.md Untracked files: .DS_Store
README.md
Outdated
| @@ -21,83 +21,83 @@ Sensitive Tree. | |||
|
|
|||
| To achieve the first goal, the primary output of this repository is a | |||
| static website which allows the reader to understand the definitions | |||
| contained here, and link to other online resources where more information | |||
| contained there and link to other online resources where more information | |||
There was a problem hiding this comment.
shouldn't this still be here since it is referring to this repo, which contains the language definitions?
There was a problem hiding this comment.
I interpreted static website as the "here" and made the change, but I see now that you're correct.
| can be obtained. | ||
|
|
||
| Links to Wikidata, Antlr definitions, E(BNF) files, example files, will | ||
| be integral components of the definitions here. | ||
| be integral components of the definitions there. |
There was a problem hiding this comment.
see previous comment on here vs there
README.md
Outdated
| and also more useful. | ||
| into a universal AST, primarily for building a test suite to verify that | ||
| the language definitions are able to parse files at useful levels of | ||
| detail. Again, focusing on style-defined subsets of languages, which are |
There was a problem hiding this comment.
I can see why you added a period and capitalized Again, but there is now a new sentence fragment that should be clarified. maybe change focusing to focus, so that the fragment becomes a complete sentence.
|
|
||
| ## Phases | ||
|
|
||
| These phases will be overlapping slightly. | ||
| These phases will be slightly overlapping. |
There was a problem hiding this comment.
No need to change the position of overlapping, IMO.
There was a problem hiding this comment.
I do believe it's correct both ways, but it reads more naturally to have the adverb before that thing that it modifies, imo.
README.md
Outdated
| definitions, and should allow users to define their own custom styles, | ||
| however the priority will be accurately describing well established | ||
| definitions, and should allow users to define their own custom styles. | ||
| The priority, however, will be accurately describing well-established | ||
| style guides, and important features of commonly used linters of various |
There was a problem hiding this comment.
don't think a comma is needed here between guides and and
README.md
Outdated
| that the imports are complete, or that partial definitions allow correct | ||
| partial parsing of those languages where complete parsing is too complex. | ||
| In this phase, tools to convert the coAST definitions into other syntax | ||
| will be needed to roundtrip the language definitions. This will provide |
There was a problem hiding this comment.
will be needed to roundtrip the language definitions - what is roundtrip supposed to mean in this phrase?
There was a problem hiding this comment.
Not entirely certain, I just made it one word.
README.md
Outdated
|
|
||
| ### Phase 1: Replace coala language definitions | ||
|
|
||
| The language definitions found at | ||
| https://github.com/coala/coala/tree/master/coalib/bearlib/languages | ||
| will be manually added as language definitions here, growing the schema | ||
| as necessary. Once the import of facts is complete, a generator will | ||
| will be manually added as language definitions, growing the schema |
There was a problem hiding this comment.
I think we can keep the here, no need to remove it
There was a problem hiding this comment.
Going off of your comment above, I'd agree.
ghost
changed the title
|
Made updates based upon your feedback in a second commit, @CLiu13. |
| @@ -11,8 +11,8 @@ generic. | |||
| language can be obtained by reading online resources rather than code. | |||
|
|
|||
| 2. Provide multiple usable levels of parse-ability, so that a file can | |||
| be accurately split into parts which are not yet parse-able, or the | |||
| use case has no benefit in parsing, and the parts may be modified | |||
| be accurately split into parts which are not yet parse-able -- or the | |||
There was a problem hiding this comment.
Why? It seems grammatically correct earlier.
There was a problem hiding this comment.
The number of commas made the sentence confusing to read. This portion of the sentence was an aside, so I enclosed it in en dashes.
There was a problem hiding this comment.
The number of commas made the sentence confusing to read. This portion of the sentence was an aside, so I enclosed it in en dashes.
There was a problem hiding this comment.
Maybe add and then the parts may be modified while retaining the commas?
| definitions into metasyntax used by other parsing toolkits, such as BNF | ||
| and derivatives, Antlr .g4, and augeas. | ||
|
|
||
| 3. Standardise the definition schema once a sufficiently large number | ||
| of language definitions have been adequately verified to determine |
There was a problem hiding this comment.
Adequately provides a sort of commitment.
|
|
||
| ### Phase 3: Create language style definitions | ||
|
|
||
| Create declarative descriptions of common styles, such as the Google Python | ||
| coding guidelines, and Airbnb JavaScript style. |
There was a problem hiding this comment.
This is not an Oxford comma.
“Such as X and Y”.
Not “such as X, and Y.”
There was a problem hiding this comment.
Oh right.
Resolve this conversation if possible :-)
|
Also, please don't forget to follow the commit guidelines , and squash your commits. |
There was a problem hiding this comment.
Hey,
- The commit message should be as per the commit guidelines.
- Also, you will have to rebase it later.
- The title doesn't really go along the guidelines, either.
- I heartily request you to work on issues when they're assigned to you.
- Also, it is very much recommended to read the Newcomer's Guide.
Committer: Shibatan [email protected]
On branch add-shibatan
Changes to be committed:
modified: README.md