Skip to content

rename greycomatrix and greycoprops. prefer "gray" in documentation#5385

Merged
alexdesiqueira merged 8 commits intoscikit-image:mainfrom
grlee77:graycomatrix_graycoprops_docs
May 12, 2021
Merged

rename greycomatrix and greycoprops. prefer "gray" in documentation#5385
alexdesiqueira merged 8 commits intoscikit-image:mainfrom
grlee77:graycomatrix_graycoprops_docs

Conversation

@grlee77
Copy link
Copy Markdown
Contributor

@grlee77 grlee77 commented May 11, 2021

Description

partially resolves #2604 (following the trend of previous work in the color module for rgb2grey->rgb2gray, etc)

The first commit deals initiates a deprecation for:
greycomatrix -> graycomatrix
greycoprops -> graycoprops

My main question for that commit is the version to set for the deprecation. I have it as 1.0, but am fine with increasing it to a subsequent release if we want to give at least 2 releases before removing the old functions.

The remaining commits involve consistently using gray rather than grey in the documentation.

I can address the remaining uses of grey in functions and filenames in the morphology module in a separate PR.

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.

@grlee77 grlee77 added 🔧 type: Maintenance Refactoring and maintenance of internals 🔽 Deprecation Involves deprecation 📜 type: API Involves API change(s) labels May 11, 2021
@grlee77 grlee77 added this to the 0.19 milestone May 11, 2021
@pep8speaks
Copy link
Copy Markdown

pep8speaks commented May 11, 2021

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

Line 234:47: E241 multiple spaces after ','
Line 234:52: E241 multiple spaces after ','

Comment last updated at 2021-05-11 15:55:07 UTC

@mkcor
Copy link
Copy Markdown
Member

mkcor commented May 11, 2021

My main question for that commit is the version to set for the deprecation. I have it as 1.0, but am fine with increasing it to a subsequent release if we want to give at least 2 releases before removing the old functions.

I find that it's okay for this particular change. I would be like @JDWarner on this one 😉

@alexdesiqueira alexdesiqueira merged commit 04f6805 into scikit-image:main May 12, 2021
@alexdesiqueira
Copy link
Copy Markdown
Member

Looks great! Thank you @grlee77!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🔽 Deprecation Involves deprecation 📜 type: API Involves API change(s) 🔧 type: Maintenance Refactoring and maintenance of internals

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SKIP: gray vs grey

4 participants