chore: document some arguments as optional #873
Merged
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
nikku
approved these changes
Mar 19, 2024
|
Released with v14.2.0 |
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.
Hi,
we're in the process of upgrading from our own typedefs to the official diagram-js ones and found some cases where arguments are theoretically optional but documented as required in the jsdoc.
This PR adjusts the cases we noticed our build complaining.
The changes are usually where the argument is consumed with a fallback value in the javascript code, e.g.
argument || {}.If you expect these arguments not to be optional in the generated types, I can also close the PR.
Thanks