Skip to content
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

Merged
merged 12 commits into from
Jul 29, 2020

Conversation

jacobtolar
Copy link
Contributor

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.

@jacobtolar
Copy link
Contributor Author

Ping someone on the PR (Lots of people, including myself, won't get a notification unless pinged directly)

Oops, I missed this item.

@pseudomuto - please take a look; thanks!

Copy link
Owner

@pseudomuto pseudomuto left a 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:

  1. Add the deprecated notification to the DocBook template as well
  2. Add an entry to the CHANGELOG.md file

Once added we'll get this merged

fixtures/Booking.proto Show resolved Hide resolved
Copy link
Contributor Author

@jacobtolar jacobtolar left a 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!

fixtures/Booking.proto Show resolved Hide resolved
Copy link
Owner

@pseudomuto pseudomuto left a 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!

CHANGELOG.md Outdated Show resolved Hide resolved
version.go Outdated Show resolved Hide resolved
@pseudomuto pseudomuto merged commit 14c9663 into pseudomuto:master Jul 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants