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.

Sign up for GitHub

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

Jump to bottom

docs: add permission tags to JSDocs #15541

Merged
merged 5 commits into from
Aug 23, 2022
Merged

docs: add permission tags to JSDocs #15541

merged 5 commits into from
Aug 23, 2022

Conversation

kitsonk
Copy link
Contributor

@kitsonk kitsonk commented Aug 22, 2022 •
edited
Loading

This is part of the effort to improve our documentation of APIs.

@kitsonk kitsonk requested a review from crowlKats August 22, 2022 21:21
bartlomieju
bartlomieju approved these changes Aug 22, 2022
View reviewed changes
Copy link
Member

@bartlomieju bartlomieju left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

crowlKats
crowlKats reviewed Aug 22, 2022
View reviewed changes
cli/dts/lib.deno.ns.d.ts Outdated Show resolved Hide resolved
crowlKats
crowlKats reviewed Aug 22, 2022
View reviewed changes
cli/dts/lib.deno.ns.d.ts Outdated Show resolved Hide resolved
@crowlKats
Copy link
Member

some web APIs require permissions, tags should be added for those as well

kitsonk and others added 2 commits August 23, 2022 07:42
@kitsonk @crowlKats
add allow-write
5ce224d 
Co-authored-by: Leo Kettmeir <[email protected]>
@kitsonk @crowlKats
add allow-write
6d9390a 
Co-authored-by: Leo Kettmeir <[email protected]>
@kitsonk
Copy link
Contributor Author

kitsonk commented Aug 22, 2022

some web APIs require permissions, tags should be added for those as well

I looked for allow in the JSDoc and tagged those that mentioned it. Feel free to push to this PR.

crowlKats
crowlKats reviewed Aug 22, 2022
View reviewed changes
cli/dts/lib.deno.ns.d.ts Outdated Show resolved Hide resolved
@kitsonk kitsonk merged commit d0c5477 into denoland:main Aug 23, 2022
@kitsonk kitsonk deleted the docs_tags branch August 23, 2022 00:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bartlomieju bartlomieju bartlomieju approved these changes

@crowlKats crowlKats crowlKats approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@kitsonk @crowlKats @bartlomieju