Update and fix connectivity docs

[user27182]

Overview

Follow up from #4824. Improve docs and include minor bug fixes.

Details

• Fix compute-volume example to use the correct connectivity scalar_range (percentages taken from threshold_percent were previously incorrectly used)
• Fix list formatting for versionadded directive and variable_input param (lists were previously formatted as a paragraph)
• Remove single float use case for scalar_range (must be a sequence with two values) and add relevant test cases
• Update See Also section with relevant methods (methods are now also hyperlinked)
• Move long examples to examples/01-filter/connectivity.py
• Add new short docstring examples
• Other minor documentation fixes to improve readability / clarity
• Fix bug with 'specified' mode where specifying an unused region id would raise an unexpected KeyError. The filter now correctly returns an empty mesh.
• Fix bug with PolyData.clean where it would would raise an error when cleaning a mesh with points but no cells

[codecov]

Codecov Report

Merging #4872 (fea9233) into main (279c9ff) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #4872   +/-   ##
=======================================
  Coverage   95.96%   95.96%           
=======================================
  Files         130      130           
  Lines       21465    21476   +11     
=======================================
+ Hits        20598    20609   +11     
  Misses        867      867           

[tkoyama010]

Thank you for suggesting the correction, I do have one suggestion. The docstring Example section of connectivity seems a bit long in my mind. Could you move that content to examples/01-filter/connectivity.py? For us, the docstring is an introduction to using the method by default in a simple way, and we would like to see a separate example page for more detailed usage.

[user27182]

Could you move that content to examples/01-filter/connectivity.py?

Ok. I agree this is a better place for these. The examples have been moved with some edits / changes, and new, simpler, docstring examples added. See the updated PR Overview for details.

[tkoyama010]

LGTM. Thanks!