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

[doc] global documentation update. #38

Merged
merged 3 commits into from
Apr 6, 2018
Merged

Conversation

AcckiyGerman
Copy link
Contributor

Issue: datahubio/datahub-v2-pm#136

Added description and code examples of major package modules:
get
info
init
login
validate
cat

  • using datahub-client to push data

Copy link
Member

@anuveyatsu anuveyatsu left a comment

Choose a reason for hiding this comment

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

Overall, I think we should provide instructions for this library only, not how to push/get.. E.g., explain DataHub class and its arguments etc. If it takes instance of Dataset class just say so and should go to data.js library and read about it there.

@AcckiyGerman @zelima wdyt?

@AcckiyGerman
Copy link
Contributor Author

@anuveyatsu agree, removing "get/push" sections from here, adding links to data.js docs

@AcckiyGerman AcckiyGerman merged commit 2a0ec23 into master Apr 6, 2018
@AcckiyGerman AcckiyGerman deleted the docs/global_readme_update branch April 6, 2018 10:16
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.

2 participants