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

Turn single backquotes to double backquotes in filters #4127

Merged
merged 12 commits into from
Sep 1, 2019

Conversation

sciunto
Copy link
Member

@sciunto sciunto commented Aug 29, 2019

Description

See #4117

I applied a regexp and checked the diff. So far, it's applied only on the filters submodule.
I would like to have your feedback first.

I think it is worth it: better documentation, less "bad" examples for future contributions.

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.
  • Consider backporting the PR with @meeseeksdev backport to v0.14.x

@pep8speaks
Copy link

pep8speaks commented Aug 29, 2019

Hello @sciunto! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 163:80: E501 line too long (80 > 79 characters)

Comment last updated at 2019-09-01 10:24:45 UTC

Copy link
Member

@soupault soupault left a comment

Choose a reason for hiding this comment

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

@sciunto Since warning and error messages are not rendered, I suggest to keep there the previous versions. Otherwise, this is a clear improvement, 👍 .

skimage/filters/ridges.py Outdated Show resolved Hide resolved
skimage/filters/thresholding.py Outdated Show resolved Hide resolved
skimage/filters/thresholding.py Outdated Show resolved Hide resolved
skimage/filters/ridges.py Outdated Show resolved Hide resolved
skimage/filters/ridges.py Outdated Show resolved Hide resolved
skimage/filters/ridges.py Outdated Show resolved Hide resolved
skimage/filters/thresholding.py Outdated Show resolved Hide resolved
skimage/filters/thresholding.py Outdated Show resolved Hide resolved
skimage/filters/thresholding.py Outdated Show resolved Hide resolved
skimage/filters/thresholding.py Outdated Show resolved Hide resolved

Parameters
----------
image: ndarray
image : ndarray
Copy link
Member

Choose a reason for hiding this comment

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

Are these new spaces a thing?

Copy link
Member Author

Choose a reason for hiding this comment

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

This is a fix to match the convention.

Copy link
Member

Choose a reason for hiding this comment

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

people just make up standards. I guess it does follow the numpydoc documentation
https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard

but I would have thought that there should be no space, like a python dictionary.

@soupault soupault merged commit b6c1847 into scikit-image:master Sep 1, 2019
@soupault soupault added the 📄 type: Documentation Updates, fixes and additions to documentation label Sep 1, 2019
@sciunto sciunto deleted the backquotes branch September 1, 2019 18:42
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.

4 participants