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.

Sign up for GitHub

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

Jump to bottom

DOC Update viewer.md #11

Merged
merged 3 commits into from
Nov 30, 2022
Merged

DOC Update viewer.md #11

merged 3 commits into from
Nov 30, 2022

Conversation

lucyleeow
Copy link
Collaborator

@lucyleeow lucyleeow commented Oct 18, 2022 •
edited
Loading

Description

Porting over of: napari/napari#5164

  • Updates syntax so classes/functions link to their API
  • Amends the headers to match the names used in 'viewer_layout.jpg'
  • Adds link to layers at a glance
  • Minor wording changes
  • Uses imshow instead of view_image - relates to DOC Document imshow #14
  • As suggested here tried to make the code examples copy-paste runnable. Due to the way the doc is laid out this was not always possible but each section is runnable if the code in that section is run in sequence.

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
psobolewskiPhD
psobolewskiPhD approved these changes Oct 18, 2022
View reviewed changes
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.

Few nitpicks plus one more thing I can't do in the suggestions for some reason:
the last code block shows the viewer.close().
(Line 521-523)
It should have the :tags: [remove-cell] I think, like the others.

docs/tutorials/fundamentals/viewer.md Outdated
@@ -31,24 +31,25 @@ on the screen and the data inside of it.

## Launching the viewer

As discussed in [getting started](./getting_started) tutorial the napari viewer
As discussed in the [getting started](./getting_started) tutorial the napari viewer
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
As discussed in the [getting started](./getting_started) tutorial the napari viewer
As discussed in the [getting started](./getting_started) tutorial, the napari viewer

Nit pick

docs/tutorials/fundamentals/viewer.md Outdated
`shift` or `command` click to select either all the layers in between clicked-on
layers or just the clicked-on layers respectively.
`shift` to select either all the layers in between two clicked-on layers or
`command` click to select all layers clicked-on.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`command` click to select all layers clicked-on.
`command` click to select individual clicked-on layers.

Nit?

docs/tutorials/fundamentals/viewer.md Outdated
For example, if you add a `Points` layer after adding an `Image` layer you will
now see different controls present.
For example, if you add a `Points` layer after adding an `Image` layer, the
new `Points` layer would be 'selected', and you will now see different controls
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
new `Points` layer would be 'selected', and you will now see different controls
new `Points` layer will be 'selected' and you will now see different controls

Nit?

docs/tutorials/fundamentals/viewer.md Outdated
Underneath the layers list there is a row of buttons. The first is the `Console`
button that will show or hide our console, allowing you to interact with a
python kernel. Inside the console you can access the
{class}`Viewer<napari.Viewer>` instance using the `viewer`.

When the console button is clicked, the console will appear at the bottom of the
Copy link
Member

Choose a reason for hiding this comment

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

Should we add a note that the console is disabled when the viewer is opened from ipython/jupyter in favor of the user continuing the use of those interactive consoles?
See user confusion for example here napari/napari#5211

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good idea, I didn't know this!

@lucyleeow
Copy link
Collaborator Author

Thank you! Changes made!

@melissawm
Copy link
Member

Hi all 👋🏻 - is there anything I can do to help push this forward? Thanks!

@psobolewskiPhD
Copy link
Member

psobolewskiPhD commented Nov 30, 2022 •
edited
Loading

Sorry @melissawm I was skittish to merge things at first—still very anxious about it—and then forgot about this.
Merging. 🙏

Edit: Gah! Conflict! My nemesis.

@psobolewskiPhD
Copy link
Member

I resolved the conflict—I think it's clear?
Waiting on CI to review the built docs. If they look OK, will merge.
If my resolution leaves something to be desired, please open a new PR—sorry!

@psobolewskiPhD psobolewskiPhD merged commit 79acfea into napari:main Nov 30, 2022
@psobolewskiPhD psobolewskiPhD modified the milestones: 0.5.0, 0.4.18 Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@psobolewskiPhD psobolewskiPhD psobolewskiPhD approved these changes

Assignees

@lucyleeow lucyleeow

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.4.18
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@lucyleeow @melissawm @psobolewskiPhD