Skip to content

Add an example notebook with analyses for the Top 12 German companies #1024

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

Merged
merged 3 commits into from
Feb 12, 2025

Conversation

devcrocod
Copy link
Contributor

No description provided.

@zaleslaw zaleslaw self-requested a review January 28, 2025 17:56
Copy link
Collaborator

@zaleslaw zaleslaw left a comment

Choose a reason for hiding this comment

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

What should be changed before to became an official example?

The next few points:

  1. Add the Header and description to the Notebook, its main purpose and Summary for what goals are you going to achieve
  2. Add some explanation as cells with texts to the given results/charts
  3. Add a way, how you got the dataset, could it be repeated by the user
  4. Rename a dataset to something shorter and in typical style
  5. Rename a folder in notebooks
  6. Also feel free to add a readme for that case
  7. Fell free to enrich with links on Kandy documentation when you using or customizing some charts

@devcrocod
Copy link
Contributor Author

Added a title, description of steps, and general explanations.

Published the notebook on Datalore and included it in the README.

Some points I didn't:
3. There is data in the same folder as the notebook.
4. In my opinion, the title is appropriate, as it clearly conveys the purpose of the example. I'm not sure what style you mean.
5. The same applies to the folder name.
7. This example uses very simple charts that don't require additional explanations.

@zaleslaw zaleslaw merged commit 5a8fe00 into master Feb 12, 2025
5 checks passed
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