Verbose Header Object documentation (3.0.4) #3867
Merged
Conversation
This file contains hidden or 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
This copies the relevant Parameter Object fields to the Header Object instead of relying on implicit guidance. The text for the fields has been edited to reflect that only headers are being described. This also include an example of describing a header using the `content` field, and explaining why it is necessary to do so.
handrews
added
clarification
...to placate the PR checks in GitHub.
ralfhandl
reviewed
Jun 4, 2024
Co-authored-by: Ralf Handl <[email protected]>
lornajane
reviewed
Jun 4, 2024
Co-authored-by: Ralf Handl <[email protected]>
miqui
previously approved these changes
Jun 7, 2024
Co-authored-by: Ralf Handl <[email protected]>
miqui
approved these changes
Jun 9, 2024
ralfhandl
approved these changes
Jun 10, 2024
|
This has two TSC approvals and a third positive-comment-with-questions-that-have-been-resolved near-approval so I'm going to merge this to start to reduce the amount of conflicts with empty sections and the like. |
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.
Fixes:
This copies the relevant Parameter Object fields to the Header Object instead of relying on implicit guidance. The text for the fields has been edited to reflect that only headers are being described.
This also include an example of describing a header using the
contentfield, and explaining why it is necessary to do so.NOTE: Includes some appendix headings to placate the PR markdown validation check.