-
Notifications
You must be signed in to change notification settings - Fork 905
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
Improve DataSet API documentation with YAML examples #1844
Improve DataSet API documentation with YAML examples #1844
Conversation
@noklam this is my draft pr. First PR, so any advice/input is welcome |
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.
Thanks @levimjoseph for the PR and sorry for the really late review.
Just to check if you have run some of the code to check if the YAML API works?
I notice there are some inconsistencies (some of them are inherit from our docs). In general, the Python API and YAML API are the describing the same dataset, which I like because it demonstrate how to map these arguments clearly.
In some cases the original example are too simple, so I think it's fine even if the new YAML API are not exactly the same.
There are way too many s3
, gcs
paths that are too complicated as an exampe, but we will address this later. For API docs I think it's nice to have at least 1 example that is easy to copy & paste without too many setups.
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.
Thanks for taking this on @levimjoseph 👍 I've left some comments.
Hi @levimjoseph , do you need some help finishing this PR? |
Hi @levimjoseph do you still want to complete this PR, or should someone from the team take-over? We'd like to get all PRs related to datasets to be merged soon now we're moving our datasets code to a different package (see our medium blog post for more details) |
Co-authored-by: Nok Lam Chan <nok_lam_chan@mckinsey.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
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.
Looks good ⭐️ Thank you @levimjoseph and @merelcht
Description
Adding YAML documentation
In response to: #1762
Development notes
I changed the following files:
I ran the test suite.
Checklist
RELEASE.md
file