Open gsanand opened 2 months ago
Check out this pull request on
See visual diffs & provide feedback on Jupyter Notebooks.
Powered by ReviewNB
Would it be more straightforward for CI testing to have these two notebooks in separate PRs?
@mackjenn good point, I'm not sure. @haticekaratay what would you prefer? happy to make the switch if desired.
@mackjenn good point, I'm not sure. @haticekaratay what would you prefer? happy to make the switch if desired.
Yes, we prefer one notebook for each PR, but let's not go through the trouble of creating a second one this time. I'll review both at once. However, upcoming PRs can be singles. Thanks.
@mgough-970 @haticekaratay I tried to modify the file handling in hopes that it would help the CI, but now the CI can't even find the image file that is made as part of the notebook itself. I don't really know what to do from here
This notebook checklist has been made available to us by 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
<h1>
or# in markdown
).1., 2.,
etc. in Markdown).The Rest of the Cells
#
in Markdown) used in the notebook.Text
Code
Images
[ ] All images (jpg, png, svgs) have an image description. This could be
alt
property)alt
attribute with no value)[ ] 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
[ ] 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.