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

Update wfss notebooks to not fail CI #175

Merged
merged 10 commits into from
Oct 18, 2023

Conversation

camipacifici
Copy link
Contributor

Updated the requirement file to use the most recent version of the required packages.

This notebook checklist has been made available to us by the the Notebooks For All team.
Its purpose is to serve as a guide for both the notebook author and the technical reviewer highlighting critical aspects to consider when striving to develop an accessible and effective notebook.

The First Cell

  • The title of the notebook in a first-level heading (eg. <h1> or # in markdown).
  • A brief description of the notebook.
  • A table of contents in an ordered list (1., 2., etc. in Markdown).
  • The author(s) and affiliation(s) (if relevant).
  • The date first published.
  • The date last edited (if relevant).
  • A link to the notebook's source(s) (if relevant).

The Rest of the Cells

  • There is only one H1 (# in Markdown) used in the notebook.
  • The notebook uses other heading tags in order (meaning it does not skip numbers).

Text

  • All link text is descriptive. It tells users where they will be taken if they open the link.
  • All acronyms are defined at least the first time they are used.
  • Field-specific/specialized terms are used when needed, but not excessively.

Code

  • Code sections are introduced and explained before they appear in the notebook. This can be fulfilled with a heading in a prior Markdown cell, a sentence preceding it, or a code comment in the code section.
  • Code has explanatory comments (if relevant). This is most important for long sections of code.
  • If the author has control over the syntax highlighting theme in the notebook, that theme has enough color contrast to be legible.
  • Code and code explanations focus on one task at a time. Unless comparison is the point of the notebook, only one method for completing the task is described at a time.

Images

  • All images (jpg, png, svgs) have an image description. This could be

    • Alt text (an alt property)
    • Empty alt text for decorative images/images meant to be skipped (an alt attribute with no value)
    • Captions
    • If no other options will work, the image is decribed in surrounding paragraphs.
  • Any text present in images exists in a text form outside of the image (this can be alt text, captions, or surrounding text.)

Visualizations

  • All visualizations have an image description. Review the previous section, Images, for more information on how to add it.

  • Visualization descriptions include

    • The type of visualization (like bar chart, scatter plot, etc.)
    • Title
    • Axis labels and range
    • Key or legend
    • An explanation of the visualization's significance to the notebook (like the trend, an outlier in the data, what the author learned from it, etc.)
  • All visualizations and their parts have enough color contrast (color contrast checker) to be legible. Remember that transparent colors have lower contrast than their opaque versions.

  • All visualizations convey information with more visual cues than color coding. Use text labels, patterns, or icons alongside color to achieve this.

  • All visualizations have an additional way for notebook readers to access the information. Linking to the original data, including a table of the data in the same notebook, or sonifying the plot are all options.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@camipacifici camipacifici temporarily deployed to ci_env October 12, 2023 15:29 — with GitHub Actions Inactive
@camipacifici camipacifici temporarily deployed to ci_env October 12, 2023 15:29 — with GitHub Actions Inactive
@camipacifici camipacifici temporarily deployed to ci_env October 12, 2023 15:29 — with GitHub Actions Inactive
@camipacifici camipacifici temporarily deployed to ci_env October 12, 2023 15:29 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 01:49 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 01:49 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 01:49 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 01:49 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 19:42 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 19:42 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 19:42 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 19:42 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 19:42 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 19:42 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:14 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:14 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:14 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:14 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:14 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:14 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:14 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:17 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:17 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:17 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:17 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:18 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:18 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:18 — with GitHub Actions Inactive
@haticekaratay haticekaratay temporarily deployed to ci_env October 17, 2023 20:18 — with GitHub Actions Inactive
Copy link
Collaborator

@haticekaratay haticekaratay left a comment

Choose a reason for hiding this comment

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

All style errors have been fixed, and I approve it as is since these notebooks are not intended for a technical review.

@haticekaratay haticekaratay merged commit 9536062 into spacetelescope:main Oct 18, 2023
10 checks passed
haticekaratay added a commit that referenced this pull request Oct 18, 2023
* Update wfss notebooks to not fail CI

* Address some of the style errors on the nb 03

* Fix style errors and update read_hdfs5 function

* Fix the remaining style errors on the 02 and 03 nb

* Some updates to 00

* Fix style errors on the 01 nb

* Fix minor style errors on the nb 01

* Address more style errors

* Fix remaining style errors

* Fix last two style errors

---------

Co-authored-by: Camilla Pacifici <[email protected]>
Co-authored-by: Hatice Karatay <[email protected]>
@camipacifici camipacifici deleted the update-wfss-old branch November 25, 2024 18:34
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