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

Update viewer tutorial, regarding the console button #53

Merged
merged 3 commits into from
Nov 23, 2022

Conversation

psobolewskiPhD
Copy link
Member

Description

The console button is disable for the case of launching napari from ipython and jupyter, because these are both interactive environments so it's encouraged that the user just keep using them.

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

Clarification of the docs, based on napari/napari#5213 (comment)

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.

@psobolewskiPhD
Copy link
Member Author

To be consistent, and also solve serious bug napari/napari#3338
I've made a PR to disable the napari-console when launching from vanilla python REPL:
https://github.com/napari/napari/compare/main...psobolewskiPhD:bugfix/disable_console_python_REPL?expand=1

@jni
Copy link
Member

jni commented Nov 20, 2022

Personally I like to hard-wrap the md text at 80c to make it easier to read the plaintext, but that is a nitpick. ;)

@Czaki
Copy link
Contributor

Czaki commented Nov 20, 2022

@jni did you think that add some markdown linter could be a good idea?

@jni
Copy link
Member

jni commented Nov 20, 2022

Sure!

Copy link
Member

@andy-sweet andy-sweet left a comment

Choose a reason for hiding this comment

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

Thanks for the follow-up - looks good!

Copy link
Member

@melissawm melissawm left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks @psobolewskiPhD !

@Czaki Czaki merged commit 223cd67 into napari:main Nov 23, 2022
@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

5 participants