Skip to content

Issue 3156: skimage/__init__.py Update docstring and fix import * #3265

Merged
jni merged 2 commits intoscikit-image:masterfrom
GenevieveBuckley:issue3156
Jul 29, 2018
Merged

Issue 3156: skimage/__init__.py Update docstring and fix import * #3265
jni merged 2 commits intoscikit-image:masterfrom
GenevieveBuckley:issue3156

Conversation

@GenevieveBuckley
Copy link
Copy Markdown
Contributor

@GenevieveBuckley GenevieveBuckley commented Jul 13, 2018

Description

PR for issue #3156
Replaces skimage/__init__.py line 178:

from .util.dtypes import *

with explicit import of all functions from skimage/util/dtype.py
Docstring has also been updated to describe all utitility functions imported (line 46 onward).

Checklist

[It's fine to submit PRs which are a work in progress! But before they are merged, all PRs should provide:]

  • Clean style in the spirit of PEP8
  • Docstrings for all functions
  • Gallery example in ./doc/examples (new features only). Not applicable.
  • Benchmark in ./benchmarks, if your changes aren't covered by an
    existing benchmark. Not applicable.
  • Unit tests. Not applicable, docstring update.

[For detailed information on these and other aspects see scikit-image contribution guidelines]

References

Closes #3156

For reviewers

(Don't remove the checklist below.)

  • 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

@GenevieveBuckley
Copy link
Copy Markdown
Contributor Author

GenevieveBuckley commented Jul 13, 2018

And this is off topic, but PyCharm is giving me messages about line 60 (now line 71 in this PR) in skimage/__init__.py:

import imp

The imp module is deprecated in favor of importlib, see the module's documentation...

Thought I should flag that in case it requires a decision.

@soupault soupault added this to the 0.14.1 milestone Jul 13, 2018
@codecov-io
Copy link
Copy Markdown

codecov-io commented Jul 15, 2018

Codecov Report

Merging #3265 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3265   +/-   ##
=======================================
  Coverage   81.97%   81.97%           
=======================================
  Files         339      339           
  Lines       27313    27313           
=======================================
  Hits        22391    22391           
  Misses       4922     4922
Impacted Files Coverage Δ
skimage/__init__.py 70.96% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4d62490...9ae8d4b. Read the comment docs.

@soupault soupault requested a review from jni July 28, 2018 21:02
@jni jni merged commit 17d6347 into scikit-image:master Jul 29, 2018
@hmaarrfk
Copy link
Copy Markdown
Member

hmaarrfk commented Aug 16, 2018

@meeseeksdev backport to v0.14.x

@lumberbot-app
Copy link
Copy Markdown

lumberbot-app bot commented Aug 16, 2018

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
$ git checkout v0.14.x
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 17d6347ae260319b2de654a8983fb6ab9d81a6ee
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #3265: Issue 3156: skimage/__init__.py Update docstring and fix import * '
  1. Push to a named branch :
git push YOURFORK v0.14.x:auto-backport-of-pr-3265-on-v0.14.x
  1. Create a PR against branch v0.14.x, I would have named this PR:

"Backport PR #3265 on branch v0.14.x"

And apply the correct labels and milestones.

Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon!

If these instruction are inaccurate, feel free to suggest an improvement.

@lumberbot-app lumberbot-app bot added the Still Needs Manual Backport MrMeeseeks-managed label label Aug 16, 2018
hmaarrfk pushed a commit to hmaarrfk/scikit-image that referenced this pull request Aug 16, 2018
@GenevieveBuckley @hmaarrfk
Update skimage/__init__.py docstring and fix import * statement. (sci…
693409b 
…kit-image#3265)

Fixes issue scikit-image#3156
@hmaarrfk hmaarrfk mentioned this pull request Aug 16, 2018
Closed
4 tasks
hmaarrfk pushed a commit to hmaarrfk/scikit-image that referenced this pull request Aug 16, 2018
@GenevieveBuckley @hmaarrfk
Update skimage/__init__.py docstring and fix import * statement. (sci…
e45d810 
…kit-image#3265)

Fixes issue scikit-image#3156
@hmaarrfk hmaarrfk mentioned this pull request Aug 16, 2018
Merged
9 tasks
soupault added a commit that referenced this pull request Aug 16, 2018
@soupault
Merge pull request #3361 from hmaarrfk/auto-backport-of-pr-3265-on-v0…
1d4191e 
….14.x

Update skimage/__init__.py docstring and fix import * statement. (backport of #3265)
@lagru lagru mentioned this pull request Sep 22, 2019
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@soupault soupault soupault approved these changes

@jni jni Awaiting requested review from jni

Assignees

No one assigned

Labels

Still Needs Manual Backport MrMeeseeks-managed label

Projects

None yet

Milestone

0.14.1

Development

Successfully merging this pull request may close these issues.

5 participants

@GenevieveBuckley @codecov-io @hmaarrfk @soupault @jni