Updates to API template #982
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
jrodewig
reviewed
Jul 11, 2019
| * Include default values as the last sentence of the first paragraph. | ||
| * Include a range of valid values, if applicable. | ||
| * If the parameter requires a specific delimiter for multiple values, say so. | ||
| * If the parameter supports wildcards, ditto. | ||
| * For objects or nested objects, link to a separate definition list. | ||
| * For large or nested objects, consider linking to a separate definition list. |
jrodewig
reviewed
Jul 11, 2019
shared/api-ref-ex.asciidoc
Outdated
| @@ -46,13 +46,12 @@ Guidelines for parameter documentation | |||
| *************************************** | |||
| * Use a definition list. | |||
| * End each definition with a period. | |||
| * Include the data type. | |||
| * Include whether the parameter is Optional or Required. | |||
| * Include the data type and whether the parameter is Optional or Required. | |||
There was a problem hiding this comment.
Should we reverse the order here since the current template includes optional/required THEN data type?
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.
Related to #937
This PR updates the API reference template to change the location of the Required/Optional parameter qualifier (hopefully for the last time!).
I also modified the comment about the definitions list, since I think we should have some leeway for whether we create separate pages for all objects or not. i.e. For small objects it might annoy users to be sent to a separate page.