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

Improve readability of notebooks #35

Open
17 tasks
Shreyanand opened this issue May 13, 2021 · 0 comments
Open
17 tasks

Improve readability of notebooks #35

Shreyanand opened this issue May 13, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation User Experience

Comments

@Shreyanand
Copy link
Member

As a consumer of the time series I would like to have information presented in a more readable format.

There are two things to be done for this card:

  • Split concepts notebook into two parts (concepts and modeling), Because of recent additions it has become very long.
  • Follow this template for all the notebooks to make sure the content is coherent.

Sub issue #18

Template points to keep in mind:

  • Proofread by other team member for grammar and spelling
  • Proofread by other team member for coherence and reproducibility (does the analysis make sense as you read through the code and markdown from top to bottom?)
  • Links checked and redirect correctly
  • There is a top markdown cell describing what the notebook does
  • There is a concluding markdown cell that summarizes the findings and outlines any next steps
  • All plots are the same size
  • All plots use seaborn (unless a specific functionality requires a different package)
  • All plots have a title, labeled axis, and some written description of the insights uncovered in the graph
  • Assuming correct environment, clicking "run all" works without error
  • All cells have been run and their output is displayed
  • Markdown headers are used to break up different sections
  • No error or warning messages are present in the outputs
  • All outputs are truncated to the minimum size required for explanation. No more than 20 rows.
  • Cell execution counts are in order (a working "run all" was performed just before PR)
  • All pre-commit checks pass
@Shreyanand Shreyanand self-assigned this May 13, 2021
@Shreyanand Shreyanand added User Experience documentation Improvements or additions to documentation labels May 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation User Experience
Projects
None yet
Development

No branches or pull requests

1 participant