-
Notifications
You must be signed in to change notification settings - Fork 469
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
Note deprecated fields in HTML and Markdown outputs #426
Note deprecated fields in HTML and Markdown outputs #426
Conversation
Oops, I missed this item. @pseudomuto - please take a look; thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey there, thanks for the PR!
There are two things I think should be done before merging this:
- Add the deprecated notification to the DocBook template as well
- Add an entry to the CHANGELOG.md file
Once added we'll get this merged
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will address your three suggestions. Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This LGTM 👍
Let's just address the version bump and contributing file points and get this merged!
This updates the Markdown and HTML outputs to prefix field descriptions with Deprecated. if the field is configured with
[deprecated=true]
.While there is a table at the end listing all the fields by option (at least in the HTML output), it's probably more helpful to see them in context.