Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: move section "Terminology and conventions" right after "Conformance" #353

Merged
merged 3 commits into from
Dec 6, 2021
Merged

refactor: move section "Terminology and conventions" right after "Conformance" #353

merged 3 commits into from
Dec 6, 2021

Conversation

danielpeintner
Copy link
Contributor

@danielpeintner danielpeintner commented Nov 22, 2021

resolves part#1 of #342


Preview | Diff

<p>
<dfn>JSON Schema</dfn> is defined in <a href="https://json-schema.org/specification.html">these specifications</a>.
</p>
<p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The terminology up to this point should be fine. But below this should go to the end of the doc, it's more like an addendum. If we use the proper Web platform citations, I think we can remove the stuff from here on.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More recent specs don't even have this section, as they adhere to the Web Platform and use citations from e.g. https://respec.org/xref/ or bikeshed refs https://tabatkins.github.io/bikeshed/#cli-refs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@danielpeintner
Copy link
Contributor Author

Scripting Call 2021-11-29

  • Remove terms and use cross references (comment it out starting from "The terms URL, ..")
  • Add Editor Tools Section with XRef link

@danielpeintner
Copy link
Contributor Author

I manged to get rid of all terms except ECMASCRIPT... removing causes lots of issues (defined in several places).

Moreover, xref does not show proper definitions for "JSON" etc.

Note: I also fixed an issue with [[value]] definition in our current version.

@@ -3940,99 +4037,6 @@ <h3>Denial Of Service Security Risk</h3>
</section>
</section>

<section> <h2>Terminology and conventions</h2>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of removing, we could just put these in a comment?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It has not been removed. It was moved to the top as requested.

@danielpeintner
Copy link
Contributor Author

Scripting Call 2021-12-06:
Can be merged

@danielpeintner danielpeintner merged commit ec3b3fc into w3c:main Dec 6, 2021
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.

2 participants