Properly stringify function types with signature #1735
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
When function types contain a signature (e.g. `function(string, boolean): string`), `catharsis` parses them correctly, but the type handling in JSDoc stringified them as `function`, the signature was omitted. With this change, the signature is added, too. Fixes jsdoc#1510 .
openui5bot
pushed a commit
to SAP/openui5
that referenced
this pull request
Jun 25, 2021
JSDoc reduces function types to the keyword "function", all other details of the signature (parameters, return type, constructor type) are lost. This has been reported as jsdoc/jsdoc#1510 and a fix has been proposed in jsdoc/jsdoc#1735 . This change monkey patches JSDoc 3.6.x with the change from the mentioned PR 1735. At the same time, a similar problem regarding record types (structures) is fixed. Change-Id: I0e8de19cedf13751ff512f6c8900d441a5862435
codeworrior
added a commit
to SAP/ui5-builder
that referenced
this pull request
Jun 9, 2022
JSDoc reduces function types to the keyword "function", all other details of the signature (parameters, return type, constructor type) are lost. This has been reported as jsdoc/jsdoc#1510 and a fix has been proposed in jsdoc/jsdoc#1735 . This change monkey patches JSDoc 3.6.x with the change from the mentioned PR 1735. At the same time, a similar problem regarding record types (structures) is fixed. Cherry picked from SAP/openui5@ff8dec90f
codeworrior
added a commit
to SAP/ui5-builder
that referenced
this pull request
Jun 13, 2022
JSDoc reduces function types to the keyword "function", all other details of the signature (parameters, return type, constructor type) are lost. This has been reported as jsdoc/jsdoc#1510 and a fix has been proposed in jsdoc/jsdoc#1735 . This change monkey patches JSDoc 3.6.x with the change from the mentioned PR 1735. At the same time, a similar problem regarding record types (structures) is fixed. Cherry picked from SAP/openui5@ff8dec90f
RandomByte
pushed a commit
to SAP/ui5-builder
that referenced
this pull request
Jun 14, 2022
JSDoc reduces function types to the keyword "function", all other details of the signature (parameters, return type, constructor type) are lost. This has been reported as jsdoc/jsdoc#1510 and a fix has been proposed in jsdoc/jsdoc#1735 . This change monkey patches JSDoc 3.6.x with the change from the mentioned PR 1735. At the same time, a similar problem regarding record types (structures) is fixed. Cherry picked from SAP/openui5@ff8dec90f
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.
When function types contain a signature (e.g.
function(string, boolean): string),catharsisparses them correctly, but the type handling in JSDoc stringified them asfunction, the signature was omitted.With this change, the signature is added, too.
Fixes #1510 .