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

Noah/documentation #46

Merged
merged 6 commits into from
Dec 4, 2024
Merged

Noah/documentation #46

merged 6 commits into from
Dec 4, 2024

Conversation

froyo-np
Copy link
Collaborator

@froyo-np froyo-np commented Dec 3, 2024

What

Words describing functions and types exported by the omezarr and dzi packages

How

inline jsdoc strings

This section is optional if there are no visible changes

  • If possible add screenshots of the visible additions in the UI.
  • If there are changes in the UI, add Before and After Screenshots for quick overview.
  • If there was a Figma design, add a link to that here as well.
  • Hint : Drag and Drop any images you want to add to the PR. Also you can create a gif of an interactive version and add that!

PR Checklist

  • Is your PR title following our conventional commit naming recommendations?
  • Have you filled in the PR Description Template?
  • Is your branch up to date with the latest in main?
  • Do the CI checks pass successfully?
  • Have you smoke tested the example applications?
  • Did you check that the changes meet accessibility standards?
  • Have you tested the application on these browsers?
    • Chrome (Fully supported)
    • Firefox (Major bug fixes supported)
    • Safari (Major bug fixes supported)

@froyo-np froyo-np marked this pull request as ready for review December 4, 2024 17:26
@froyo-np froyo-np requested a review from a team as a code owner December 4, 2024 17:26
@froyo-np froyo-np requested review from TheMooseman, crispipear and Jarbuckle and removed request for crispipear December 4, 2024 17:26
Copy link
Collaborator

@lanesawyer lanesawyer left a comment

Choose a reason for hiding this comment

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

Helpful! I especially appreciate the additional examples in comments of the range of numbers to expect and expected results with certain inputs

@froyo-np froyo-np merged commit fb9bee4 into main Dec 4, 2024
5 checks passed
@froyo-np froyo-np deleted the noah/documentation branch December 4, 2024 21:27
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