Fix docstring for connectivity parameter in watershed function.

[mkcor]

Description

While investigating the watershed implementation these days, I noticed that the docstring for connectivity was a bit off: In the function signature, we have connectivity=1 and then connectivity : ndarray, optional...

It turns out we use a connectivity parameter in many functions across the library, many of which use

scikit-image/skimage/morphology/_util.py

Line 8 in 9e8bf68

def _validate_connectivity(image_dim, connectivity, offset):

internally, which itself relies on scipy's generate_binary_sctructure. There's definitely room for standardization here, but I'll start with just the instance in watershed.

I've drawn from the docstring in _validate_connectivity (above).

@stefanv since this PR is docs-only, maybe it could go into v0.23?

Checklist

• A descriptive but concise pull request title
• Docstrings for all functions
• Unit tests
• A gallery example in ./doc/examples for new features
• Contribution guide is followed

Release note

We use changelist to
compile each pull request into an item of the release notes. Please refer to
the instructions
and past release notes
for guidance and examples.

Fix docstring of `connectivity` parameter in `skimage.segmentation.watershed`.

[lagru]

@stefanv since this PR is docs-only, maybe it could go into v0.23?

Did I miss the announced feature freeze or is this implicit. It's probably wise to do not add new features, but documentation and simple maintenance changes are probably fine...?

[lagru]

I think since we are no longer really using release branches we haven't really communicated about a new workflow around releases.

[mkcor]

Did I miss the announced feature freeze or is this implicit?

Same question here.

It's probably wise to do not add new features, but documentation and simple maintenance changes are probably fine...?

I would also think so.