8000 Update docstring for random_noise function by neeraj3029 · Pull Request #5001 · scikit-image/scikit-image · GitHub
[go: up one dir, main page]
Skip to content

Update docstring for random_noise function #5001

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
Merged
merged 2 commits into from
Oct 2, 2020
Merged

Update docstring for random_noise function #5001

merged 2 commits into from
Oct 2, 2020

Conversation

neeraj3029
Copy link
Contributor

Description

This pull request refers to the issue #5000

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.

sciunto
sciunto approved these changes Oct 2, 2020
View reviewed changes
Copy link
Member
@sciunto sciunto left a comment

Choose a reason for hiding this comment

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

Thank you!

mkcor
mkcor reviewed Oct 2, 2020
View reviewed changes
skimage/util/noise.py Outdated
@@ -27,7 +27,7 @@ def random_noise(image, mode='gaussian', seed=None, clip=True, **kwargs):
`low_val` is 0 for unsigned images or -1 for signed
images.
- 'speckle' Multiplicative noise using out = image + n*image, where
n is uniform noise with specified mean & variance.
n is gaussian noise with specified mean & variance.
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
n is gaussian noise with specified mean & variance.
n is Gaussian noise with specified mean & variance.

so it matches

scikit-image/skimage/util/noise.py

Lines 19 to 20 in e19fa1f

- 'gaussian' Gaussian-distributed additive noise.
- 'localvar' Gaussian-distributed additive noise, with specified

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, on it!

@mkcor
Copy link
Member
mkcor commented Oct 2, 2020

@neeraj3029 the CI fails are not related to this PR.

@sciunto could you please trigger a rerun of the failing CI workflows?

@emmanuelle
Copy link
Member

Thank you @neeraj3029 and reviewers @sciunto and @mkcor. Merging!

@emmanuelle emmanuelle merged commit a56c02f into scikit-image:master Oct 2, 2020
This was referenced Oct 2, 2020
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mkcor mkcor mkcor left review comments

@sciunto sciunto sciunto approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@neeraj3029 @mkcor @emmanuelle @sciunto
0