Closed FDauphin closed 3 months ago
Added a few enhancements to WFC3 Notebooks:
stenv
, hst_notebooks/environment.yml
, and the complementary requirements.txt
filesgeneral_tools.md
, ir_tvb.md
, and photometry.md
_toc.yml
to reflect new subsections (mentioned in #260)@haticekaratay @dulude Ready for review (low priority). I think the "Notebook Execution and Validation: notebook-execution" check failed because there were no notebooks to check. Maybe a small CI enhancement in the future to not run the check for PRs only concerning files not needed to execute notebooks?
@FDauphin, do you plan on adding anything else? If not, we can proceed with a "squash and merge". Thanks!
@FDauphin, do you plan on adding anything else? If not, we can proceed with a "squash and merge". Thanks!
@haticekaratay No that's it, feel free to merge. Thanks for the quick turnaround 🙌🏾
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.