-
Notifications
You must be signed in to change notification settings - Fork 919
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 example for using multi-sheet Excel file #1760
Conversation
docs/source/data/data_catalog.md
Outdated
@@ -164,7 +164,17 @@ rockets: | |||
sheet_name: Sheet1 | |||
``` | |||
|
|||
Example 7: Saves an image created with Matplotlib on Google Cloud Storage | |||
Example 7: Loads a multisheet excel file from a local file system |
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.
Example 7: Loads a multisheet excel file from a local file system | |
Example 7: Loads a multi-sheet Excel file from a local file system |
:)
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.
Made the change in 3f493a1, thanks!
Signed-off-by: ankatiyar <[email protected]>
aaf3119
to
3f493a1
Compare
Signed-off-by: ankatiyar <[email protected]>
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.
Congrats on your first PR⭐️
Side notes:
Follow up on previous discussion about DataSet API Docs should be the 1st entry point for people looking up examples, I think we should do the followings:
- Remove these number, i.e. Example X, make them a sub-header like
## Save-an-image-xxxxx
, so we can link these example directly in the doc, and also better SEO I think? - Only keep some of the example in
Data Catalog
to showcase what Kedro can do, but leave the advance example in the Corresponding API Doc.
- We have examples saving CSV on S3, matplotlib on GCP, excel on GCP, which I don't think add much value here, it's enough to show 1 example of GCP/S3.
- Examples like saving HDF file doesn't worth the highlight in this page in my opinion, there could be more.
Can I ask that we include the example how to save a multi-sheet as well? The instructions to do so are buried in in the DataSet docstring:
|
Yes we should, but let's do that as separate tasks to keep this PR focussed on one thing. We've got this issue for task 1: #1742. I'll update it so it covers point 2 as well. |
Signed-off-by: ankatiyar <[email protected]>
Signed-off-by: ankatiyar <[email protected]>
Signed-off-by: ankatiyar <[email protected]>
Signed-off-by: ankatiyar <[email protected]>
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.
Super close, slightly different wording suggested. Then I think we're good to go!
Signed-off-by: ankatiyar <[email protected]>
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.
🔥 awesome work @ankatiyar
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.
Congratulations on your first PR @ankatiyar! 🥳 And thank you for helping our users with this! We get this question a lot.
I'm approving this but I just note that we use excel
(lowercase) when it should be Excel
(uppercase). This actually correct based on what we have in our documentation at the moment.
Can you create a separate GitHub issue to address this as another quick-fix PR because I just checked the rest of the documentation and it looks like we've made that mistake in other places too?
Signed-off-by: ankatiyar <[email protected]> Signed-off-by: Deepyaman Datta <[email protected]>
Description
Resolves #1700
Development notes
Checklist
RELEASE.md
file