Write @deprecated jsdoc annotation if includeComments is enabled #2357
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
update golden generated with @deprecated annotation
|
|
| @@ -184,7 +189,7 @@ const typeBrandHint = `This field is a type brand and is not populated at runtim | |||
| https://github.com/grpc/grpc-node/pull/2281`; | |||
|
|
|||
| function formatTypeBrand(formatter: TextFormatter, messageType: Protobuf.Type) { | |||
| formatComment(formatter, typeBrandHint); | |||
| formatComment(formatter, typeBrandHint, messageType.options); | |||
There was a problem hiding this comment.
I don't think this one is right. This comment isn't on the message interface itself, but rather on a synthetic field in the interface. So it doesn't make sense for this field to inherit the message type's deprecated status.
There was a problem hiding this comment.
@murgatroid99 I removed the options argument for this format call.
murgatroid99
approved these changes
Feb 13, 2023
|
This is out in version 0.7.5. |
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.
By adding the JSDoc
@deprecatedannotation to the output comments to interface fields IDE's can pick it up and deliver a better developer experience. This annotation is only added when theincludeCommentsoption is enabled. Since protobuf.js already parses if a field is deprecated or not the options object with that information is passed to theformatCommentfunction.Update golden generated with @deprecated annotation.
Resolves #2348