Improve Documentation of Schema Attributes #290
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
||
| The status of each schema in XDM describes the likelihood of change of a schema. | ||
| In particular for XDM Versions prior to XDM 1.0.0, this can inform users and providers of XDM-compatible APIs of the stability of a given schema. | ||
|
|
There was a problem hiding this comment.
Having this at the schema level is fine, do we need to also have this at the field level when it deviates from the schema's "status"? For example a new field added to a stable schema but that field would not yet be stable.
There was a problem hiding this comment.
I agree. #303 covers parts of that.
cdegroot-adobe
approved these changes
May 4, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
adobe/jsonschema2md#60 and others add support for linking schema attributes in the generated documentation to sections in the narrative documentation. This PR provides descriptions for each supported attribute and links from the generated docs.
To keep the PR small, I have not included any of the updates in
docs/referencewhich will be generated automatically upon merge into master.