Skip to content

Clarify Comment Syntax#19

Open
DecimalTurn wants to merge 3 commits intomainfrom
comment
Open

Clarify Comment Syntax#19
DecimalTurn wants to merge 3 commits intomainfrom
comment

Conversation

@DecimalTurn
Copy link
Copy Markdown
Member

Addreses #9 and some other potential confusion with comment syntax.

Note that the name "Multi-line" was kept as section title since that's the terminology used in EcmaScript.

This PR will:

  • add terminology for line endings and insignificant whitespace
  • state that comments are informational only and must not affect consumed JSON values
  • clarify single-line comment behavior to end at line ending
  • expand single-line example to show a case at the end of a line
  • expand multi-line example to show a case within a line
  • mention that nested "block" comments aren't supported

@hattesen, I added you as co-author of 03b0dfd since I used your snippet to illustrate the invalid nesting syntax. I can remove the mention if you prefer before merging.

DecimalTurn and others added 3 commits March 28, 2026 23:40
- add terminology for line endings and insignificant whitespace
- state that comments are informational only and must not affect consumed JSON values
clarify single-line comment behavior to end at line ending
- expand single-line example to show case at the end of a line
Co-authored-by: hattesen <hattesen@users.noreply.github.com>
@DecimalTurn DecimalTurn marked this pull request as ready for review March 29, 2026 15:02
@github-actions
Copy link
Copy Markdown

PR Preview Action v1.6.3

🚀 View preview at
https://JSONC-org.github.io/JSONC/pr-preview/pr-19/

Built to branch main at 2026-03-29 15:02 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@DecimalTurn DecimalTurn mentioned this pull request Mar 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant