-
Notifications
You must be signed in to change notification settings - Fork 8
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
New documentation for js-dataverse v2 #118
Conversation
… into 113-documentation-v2
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
…rse-client-javascript into 113-documentation-v2
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
…nloadSize Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
…rse-client-javascript into 113-documentation-v2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@GPortas There's an integration test failing. I think is some kind of race condition, where sometimes there are more dataset locks occurring than those expected by test's assertion
… into 113-documentation-v2
LGTM! For future iterations, I would suggest adding a "Go Back to Index" button on all the documentation pages, as it can be frustrating trying to navigate back to the index |
What this PR does / why we need it:
Adds updated and structured documentation to the package, for its next release to version 2.
The docs include a section dedicated to use cases, which includes a description and example calls for each of the use cases available in the package.
Which issue(s) this PR closes:
Related Dataverse PRs:
Special notes for your reviewer:
Suggestions on how to test this: