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 the user guide to use channel_axis rather than multichannel #5556

Merged
merged 7 commits into from
Sep 3, 2021

Conversation

grlee77
Copy link
Contributor

@grlee77 grlee77 commented Sep 2, 2021

Description

closes #5554

Updates the user guide to better describe the more flexible channel support via channel_axis. Also, avoids use of the deprecated multichannel argument in examples.

The description of img_as_float was also updated slightly to indicate its current behavior (no longer automatically rescales floating point inputs and preserves floating point precision).

Checklist

For reviewers

  • Check that the PR title is short, concise, and will make sense 1 year
    later.
  • Check that new functions are imported in corresponding __init__.py.
  • Check that new features, API changes, and deprecations are mentioned in
    doc/release/release_dev.rst.

DOC: fix typo in visualization.rst
update wording of section describing BGR to RGB conversion

Better describe the current dtype and scaling behavior of img_as_float
use | to get extra space, emulating a table footnote in RST
@grlee77 grlee77 added the 📄 type: Documentation Updates, fixes and additions to documentation label Sep 2, 2021
@grlee77 grlee77 added this to the 0.19 milestone Sep 2, 2021
Copy link
Member

@mkcor mkcor 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 taking care of this!

doc/source/user_guide/numpy_images.rst Outdated Show resolved Hide resolved
doc/source/user_guide/visualization.rst Outdated Show resolved Hide resolved
doc/source/user_guide/numpy_images.rst Show resolved Hide resolved
doc/source/user_guide/numpy_images.rst Outdated Show resolved Hide resolved
doc/source/user_guide/numpy_images.rst Outdated Show resolved Hide resolved
doc/source/glossary.md Outdated Show resolved Hide resolved
grlee77 and others added 2 commits September 2, 2021 17:18
Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
doc/source/user_guide/numpy_images.rst Outdated Show resolved Hide resolved
doc/source/user_guide/numpy_images.rst Outdated Show resolved Hide resolved
Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
@grlee77
Copy link
Contributor Author

grlee77 commented Sep 3, 2021

Updated. Thanks for the helpful suggestions, @mkcor.

@grlee77
Copy link
Contributor Author

grlee77 commented Sep 3, 2021

The linux-cp3.8-pre failure here is unrelated (appears to be an issue with a new setuptools_scm release).

It looks like upstream has already fixed it in: pypa/setuptools_scm#628

@mkcor mkcor merged commit a0db46e into scikit-image:main Sep 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 type: Documentation Updates, fixes and additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update user guide to reflect channel_axis vs. multichannel
2 participants