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

add check if all notebooks have md with badges, md with description and Colab header #34

Merged
merged 27 commits into from
Oct 19, 2024

Conversation

AgnieszkaZaba
Copy link
Collaborator

I added three tests proposed by @slayoo in #8. Changed order of cells in notebooks as:

  1. markdown with badges
  2. markdown with description
  3. Colab header

In test_third_cell_contains_colab_header I set cell index as 2.

@slayoo slayoo closed this Oct 12, 2024
@slayoo slayoo reopened this Oct 12, 2024
@slayoo
Copy link
Member

slayoo commented Oct 12, 2024

Thank you @AgnieszkaZaba !
(closed and reopened the PR to trigger CI tests which were auto-disabled by GitHub due to project inactivity)

@AgnieszkaZaba
Copy link
Collaborator Author

@slayoo Should I add definitions of badge functions to test_notebooks.py or is it better to use utils?

@AgnieszkaZaba
Copy link
Collaborator Author

I added badge functions to test_notebooks.py for now.

There is a problem with empty.ipynb because it does not have proper structure. Should we change it or maybe exclude from those tests?

@slayoo
Copy link
Member

slayoo commented Oct 12, 2024

I added badge functions to test_notebooks.py for now.

👍

There is a problem with empty.ipynb because it does not have proper structure. Should we change it or maybe exclude from those tests?

Let's either rename it to template.ipynb and add there all the features that are tested, or add a separate template.ipynb file.

BTW, we maintain a set of "hints" for Python development here: https://github.com/open-atmos/python-dev-hints/wiki

@slayoo slayoo changed the title devops_tests: add check if all notebooks have md with badges, md with description and Colab header add check if all notebooks have md with badges, md with description and Colab header Oct 16, 2024
@slayoo slayoo linked an issue Oct 19, 2024 that may be closed by this pull request
@slayoo slayoo enabled auto-merge October 19, 2024 10:36
@slayoo slayoo disabled auto-merge October 19, 2024 10:41
@slayoo slayoo merged commit 488d111 into open-atmos:main Oct 19, 2024
8 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.

check notebook header cells (badges, colab magick)
2 participants