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

Some API documentation changes #3912

Closed
wants to merge 6 commits into from
Closed

Some API documentation changes #3912

wants to merge 6 commits into from

Conversation

leeper
Copy link
Member

@leeper leeper commented Jun 15, 2017

This is a documentation-only change that:

  • notes the R client for dataverse is now available from R's central repository, CRAN and updates a link to it from the SWORD API page
  • standardizes some of the formatting of example across the different API guide pages
  • moves language describing the API key to the main API index page (from the native API page)

@coveralls
Copy link

Coverage Status

Coverage remained the same at 10.038% when pulling f5c5a4f on leeper:master into b0fd002 on IQSS:master.

@leeper leeper changed the title note dataverse-client-r is available on CRAN Some API documentation changes Jun 15, 2017
@coveralls
Copy link

Coverage Status

Coverage remained the same at 10.038% when pulling 2b01a60 on leeper:master into b0fd002 on IQSS:master.

@pdurbin
Copy link
Member

pdurbin commented Jun 15, 2017

@leeper thanks for the pull request! I just advanced it to the "Code Review" column at https://waffle.io/IQSS/dataverse

@pdurbin
Copy link
Member

pdurbin commented Jun 16, 2017

@leeper if you happen to know if it's easy to change the destination branch from master to develop please let me know.

@leeper leeper changed the base branch from master to develop June 16, 2017 15:44
@leeper
Copy link
Member Author

leeper commented Jun 16, 2017

@pdurbin Did that work?

@pdurbin
Copy link
Member

pdurbin commented Jun 16, 2017

@leeper much better. Thanks!

@pdurbin
Copy link
Member

pdurbin commented Jun 19, 2017

@leeper I'm thinking I'll merge these changes with another API Guide improvement effort for #3192.

@leeper
Copy link
Member Author

leeper commented Jun 19, 2017

Sounds great!

@pdurbin
Copy link
Member

pdurbin commented Jun 19, 2017

@leeper I'm closing this issue in favor of pull request #3920

The only change I backed out of is the curl commands in the SWORD docs. We need to figure out a sane way wrap long lines, as @dlmurphy and I have discussed in #3577.

@pdurbin pdurbin closed this Jun 19, 2017
@pdurbin pdurbin removed their assignment Jul 26, 2019
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.

4 participants