Add vale linting and fix glossary#74
Conversation
|
🌐 Preview URL: https://pr-74.frcsoftware.pages.dev |
9c6f56a to
5e888d9
Compare
0ac2909 to
8517cf6
Compare
CodeMyGame1
left a comment
CodeMyGame1
left a comment
There was a problem hiding this comment.
some changes required (mostly just style fixes that I noticed while reviewing vale's fixes)
| mkdirSync(OUTPUT_DIR, { recursive: true }); | ||
| } | ||
|
|
||
| const terms = [...new Set(glossaryTerms.map(({ term }) => term))].sort((a, b) => |
There was a problem hiding this comment.
Should the uniqueness of glossaryTerms be enforced "server-side" via some sort of linting? I realize the Set() call should remain as a preventative measure, but still.
There was a problem hiding this comment.
I think this can be enforced through PR review when the glossary gets modified. That's what makes sense to me anyways.
|
|
||
| Both examples accomplish the same tasks and there is no difference. | ||
| Whether you put your comments above or next to code is up to you and what makes the most sense for your code. | ||
| Whether you put your comments preceding or alongside code is up to you and what makes the most sense for your code. |
There was a problem hiding this comment.
In this case, I think the replacements of "above" and "next to" make the sentence more difficult to read.
| Using Java, we can write code that allows a robot to run a motor, adjust speed, and much more. | ||
| There is a lot to learn when learning Java. | ||
| However, FRCSoftware will go over the basics needed to program a robot. | ||
| While there is a lot to learn when learning Java, FRCSoftware will only cover the basics needed to program a robot. |
There was a problem hiding this comment.
I would rephrase this as:
Although Java has many concepts to learn, FRCSoftware will only cover the basics needed to program a robot.
…ls.mdx Co-authored-by: Andrew Haselton <13470989+roboteer5291@users.noreply.github.com>
Co-authored-by: Andrew Haselton <13470989+roboteer5291@users.noreply.github.com>
5 participants
Adds vale linting, which checks prose for grammatical errors etc.
closes #58