Core: Improve language for schema references section #551
Conversation
jsonschema-core.xml
Outdated
| any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons | ||
| (":"), or periods ("."). | ||
| To specify such a subschema identifier, | ||
| the "$id" keyword is set to a URI reference with a name fragment (not a JSON Pointer fragment). |
There was a problem hiding this comment.
I was using "plain name" rather than just "name" because that is the terminology used in the W3C fragment best practices document that we cite. i think we should be consistent with that.
| and the URIs that identify them. | ||
| </t> | ||
| <t> | ||
| When schemas are downloaded, |
There was a problem hiding this comment.
I don't follow this paragraph. Taking the dependent clause out I read "When schemas are downloaded... see Usage over HTTP" which is a bit unclear.
Could this be rephrased as something like:
"For use cases when it is desirable to download schemas, such as a hypermedia system where schemas are discovered at runtime, see Usage for Hypermedia"
Note I'm proposing linking to section 11 as a whole rather than 11.3, because the actual linking of a downloadable schema is covered in 11.1, and I think that is needed to fully understand the issue (along with 11.3).
There was a problem hiding this comment.
Oh, I totally missed that. Yes, I was looking for that section.
No description provided.