Repository navigation
docs: fix grammar and spelling mistakes - #4413
JojocraftTv wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
@JojocraftTv Nice cleanup, the grammar and spelling fixes all look good to me. The colon spacing in the settings list is a nice touch too.
One thing though, the JSON example still isn't quite valid. The runtimes block at the top of the Project JDKs section still has trailing commas on the first two entries:
{
"name": "JavaSE-1.8",
"path": "/path/to/jdk-8",
},
{
"name": "JavaSE-11",
"path": "/path/to/jdk-11",
},Those commas after the last property make it invalid JSON, so they should go:
{
"name": "JavaSE-1.8",
"path": "/path/to/jdk-8"
},
{
"name": "JavaSE-11",
"path": "/path/to/jdk-11"
},Drop those two and the whole snippet is valid. Otherwise this is good to go.
wenytang-ms
left a comment
wenytang-ms
left a comment
There was a problem hiding this comment.
Nice cleanup, the grammar and spelling fixes all look good to me. The colon spacing in the settings list is a nice touch too.
One thing though, the JSON example still isn't quite valid. The runtimes block at the top of the Project JDKs section still has trailing commas on the first two entries:
{
"name": "JavaSE-1.8",
"path": "/path/to/jdk-8",
},
{
"name": "JavaSE-11",
"path": "/path/to/jdk-11",
},Those commas after the last property make it invalid JSON, so they should go:
{
"name": "JavaSE-1.8",
"path": "/path/to/jdk-8"
},
{
"name": "JavaSE-11",
"path": "/path/to/jdk-11"
},Drop those two and the whole snippet is valid. Otherwise this is good to go.
|
Thanks for pointing that out ^^ |
- Normalized "`setting`: description" spacing across the settings list (was inconsistently "`setting` : description" in many entries). - Fixed "eg." -> "e.g.", "3rd party" -> "third-party", and a handful of other grammar/wording issues in README.md and USAGE_DATA.md. - Fixed invalid JSON in the java.configuration.runtimes example (trailing commas before a closing brace/bracket). Rebased onto current main and reapplied by hand: the original diff conflicted with settings/runtime entries added upstream since this PR was opened. Picked up the same JSON trailing-comma issue on the newly added JavaSE-27 entry and the newly added java.referencesCodeLens.includeFields spacing issue while at it, and kept "default": true on JavaSE-25 (removing it wasn't necessary for valid JSON and conflicts with main's later intent of showing multiple default-marked entries as an example). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
PR looks fine to me. +1 once branch is unfrozen |
This branch has not been deployed
3 participants
Changes