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.

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

Add scopes to JS and TS docs #891

Merged
merged 3 commits into from
Feb 1, 2022
Merged

Add scopes to JS and TS docs #891

merged 3 commits into from
Feb 1, 2022

Conversation

sderickson
Copy link
Contributor

Update js and ts to include route scopes in their doc strings.

Checklist

General Contributing

  • Have you read the Code of Conduct and signed the CLA?

Is This a Code Change?

  • Non-code related change (markdown/git settings etc)
  • SDK Code Change
  • Example/Test Code Change

Validation

  • Does npm test pass?
  • Does npm run build pass?
  • Does npm run lint pass?
    (seems to error on examples which rely on packages that are not installed?)

@codecov
Copy link

codecov bot commented Feb 1, 2022

Codecov Report

Merging #891 (deae5a0) into main (695271c) will increase coverage by 0.21%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #891      +/-   ##
==========================================
+ Coverage   65.69%   65.90%   +0.21%     
==========================================
  Files           7        7              
  Lines         787      792       +5     
==========================================
+ Hits          517      522       +5     
  Misses        270      270              
Flag Coverage Δ
integration 53.53% <ø> (-0.47%) ⬇️
unit 64.89% <ø> (+0.22%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
lib/routes.js 51.27% <ø> (ø)
src/dropbox.js 98.66% <ø> (ø)
src/auth.js 88.48% <0.00%> (+0.42%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 695271c...deae5a0. Read the comment docs.

@sderickson sderickson changed the title Attempt to incorporate scopes into sdk Incorporate scopes into JS and TS docs Feb 1, 2022
@sderickson sderickson changed the title Incorporate scopes into JS and TS docs Add scopes to JS and TS docs Feb 1, 2022
@rogebrd
Copy link
Contributor

rogebrd commented Feb 1, 2022

Looks good to me but please wait until stone has been merged and include the bump of stone version to this diff

sderickson added a commit to dropbox/stone that referenced this pull request Feb 1, 2022
Add --attribute-comment field to js_client.py and tsd_client.py, like the one added to python_client.py in #262. This is a prerequisite for dropbox/dropbox-sdk-js#891 which adds scopes to the outputted clients for easier reference.

Also adds appropriate testing and updates the docstring for the python_client.py, making it more succinct and aligned with the other two.
@sderickson sderickson merged commit 52e6a5f into main Feb 1, 2022
@sderickson sderickson deleted the add-scopes-to-descriptions branch February 1, 2022 19:09
rogebrd pushed a commit that referenced this pull request Mar 22, 2022
Update js and ts to include route scopes in their doc strings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants