Move JS doc tags like @param [obj.prop] to the interface
#4974
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
dsherret
commented
Apr 28, 2020
| sameSite?: SameSite; | ||
| /** Additional key value pairs with the form "key=value" */ |
There was a problem hiding this comment.
This was missing so I added it. Let me know if it can be better.
| * @param [opts.extended=false] Support advanced ext globbing | ||
| * @param [opts.globstar=false] Support globstar | ||
| * @param [opts.strict=true] be laissez faire about mutiple slashes | ||
| * @param [opts.filepath=""] Parse as filepath for extra path related features |
There was a problem hiding this comment.
The default is actually false and not "". This is a confusing property name.
SASUKE40
pushed a commit
to SASUKE40/deno
that referenced
this pull request
May 7, 2020
caspervonb
pushed a commit
to caspervonb/deno_std
that referenced
this pull request
Jan 21, 2021
caspervonb
pushed a commit
to caspervonb/deno_std
that referenced
this pull request
Jan 24, 2021
caspervonb
pushed a commit
to caspervonb/deno_std
that referenced
this pull request
Jan 24, 2021
caspervonb
pushed a commit
to caspervonb/deno_std
that referenced
this pull request
Jan 24, 2021
caspervonb
pushed a commit
to caspervonb/deno_std
that referenced
this pull request
Jan 31, 2021
caspervonb
pushed a commit
to caspervonb/deno_std
that referenced
this pull request
Jan 31, 2021
caspervonb
pushed a commit
to caspervonb/deno_std
that referenced
this pull request
Jan 31, 2021
caspervonb
pushed a commit
to caspervonb/deno_std
that referenced
this pull request
Jan 31, 2021
caspervonb
pushed a commit
to caspervonb/deno_std
that referenced
this pull request
Feb 1, 2021
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.
I was looking at Deno Doc and it looks like this:
This PR moves any
@param [obj.prop]jsdoc tags those docs to the interface object, which will improve how it looks in Deno Doc.I know there's no issue for this, but this seemed like an easy quick fix to not bother (took only a few minutes).