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

changed image1 to moving_image in tvl1 parameter docs #6480

Merged
merged 1 commit into from Aug 19, 2022

Conversation

cwood1967
Copy link
Contributor

Description

The docstrings in skimage.registration._optical_flow.py for optical_flow_tvl1 and _tvl1 both have the parameter num_warp described as Number of times image1 is warped. This is confusing since image1 could be either the reference_image or the moving_image. The _ilk docstrings have moving_image rather than image1, so this change would make it consistent.

Checklist

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

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.
  • There is a bot to help automate backporting a PR to an older branch. For
    example, to backport to v0.19.x after merging, add the following in a PR
    comment: @meeseeksdev backport to v0.19.x
  • To run benchmarks on a PR, add the run-benchmark label. To rerun, the label
    can be removed and then added again. The benchmark output can be checked in
    the "Actions" tab.

@cwood1967 cwood1967 changed the title changed image to moving_image in tvl1 parameter docs changed image1 to moving_image in tvl1 parameter docs Aug 19, 2022
@alexdesiqueira
Copy link
Member

Thank you @cwood1967, nice catch! Likely possible that at some point the parameters were image0, image1 and we forgot to update the docs 😅
Thanks again!

@alexdesiqueira alexdesiqueira merged commit b7abcce into scikit-image:main Aug 19, 2022
@lagru lagru added the 📄 type: Documentation Updates, fixes and additions to documentation label Aug 20, 2022
@jarrodmillman jarrodmillman added this to the 0.20 milestone Oct 4, 2022
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.

None yet

4 participants