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

Use imshow in getting_started #9

Merged
merged 2 commits into from
Oct 24, 2022
Merged

Use imshow in getting_started #9

merged 2 commits into from
Oct 24, 2022

Conversation

lucyleeow
Copy link
Collaborator

Description

Porting over of: napari/napari#5184
Relates to #14

  • Replace view_image with imshow in getting started.
  • Updates syntax so classes/functions link to their API.
  • Minor other changes.

Note that the images in getting started should probably be updated but outside scope of this PR.

Type of change

  • Bug-fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

References

How has this been tested?

  • example: the test suite for my feature covers cases x, y, and z
  • example: all tests pass with my change

Final checklist:

  • My PR is the minimum possible work for the desired functionality
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • If I included new strings, I have used trans. to make them localizable.
    For more information see our translations guide.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 18, 2022
@lucyleeow
Copy link
Collaborator Author

lucyleeow commented Oct 18, 2022

Thank you @jni and @psobolewskiPhD for your reviews over in napari/napari#5184

I have updated the screenshots so they show the cells and not the astronaut.
Happy to amend the screenshots or use your mac screenshot instead. Have left the outdated but correct content screenshots as suggested but happy to update those as well.

(ready for review)

Copy link
Member

@psobolewskiPhD psobolewskiPhD left a comment

Choose a reason for hiding this comment

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

The new screenshots look good to me!

@jni jni merged commit 48443c7 into napari:main Oct 24, 2022
@lucyleeow lucyleeow deleted the doc_get_start branch October 24, 2022 06:54
@lucyleeow
Copy link
Collaborator Author

Thank you!

@Czaki
Copy link
Contributor

Czaki commented Oct 24, 2022

Should this be ported o to 0.4.17 docs (as this release does not use new docs infrastructure)?

@jni
Copy link
Member

jni commented Oct 26, 2022

Oof. On the one hand, yes, on the other, it's not essential — you don't have to use imshow. My preference is that we work out how to update each version's docs here independently of the core repo. Then we can use that infra to make any changes we like to each version's docs, including using imshow in /stable/

@psobolewskiPhD psobolewskiPhD added this to the 0.4.18 milestone Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants