Add docstring to the transform module

[rum1887]

Description

Added Docstring to the transform module. Updates the issue #6761

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.

[lagru]

Wow, nice work @rum1887! That's a lot more detailed than what I would have anticipated and already reads quite well. We could include this as is, however with how detailed it is I fear it might get outdated quickly.

What do you think about restructuring things a bit to have a more natural flow? Maybe something like the following that includes what you wrote but in a more general style that's less focused on the implementation and more on the purpose.

"This module includes tools to transform images and volumetric data such as:

• Geometric transformations can manipulate the shape and position of an image and are useful for tasks such as image registration, alignment, and geometric correction.
• ...

"

[rum1887]

Wow, nice work @rum1887! That's a lot more detailed than what I would have anticipated and already reads quite well. We could include this as is, however with how detailed it is I fear it might get outdated quickly.

What do you think about restructuring things a bit to have a more natural flow? Maybe something like the following that includes what you wrote but in a more general style that's less focused on the implementation and more on the purpose.

"This module includes tools to transform images and volumetric data such as:

• Geometric transformations can manipulate the shape and position of an image and are useful for tasks such as image registration, alignment, and geometric correction.
• ...

"

I agree that it might get outdated :)

How about providing a few functions as examples under each category for ease of understanding instead of an exhaustive list of functions available at scikit-image.tranform module?

Maybe I could add a note mentioning that the examples are not exhaustive and point them to the documentation

[lagru]

@rum1887, thanks. This is shaping up! :) I've left a few more suggestions.

[rum1887]

@rum1887, thanks. This is shaping up! :) I've left a few more suggestions.

@lagru done :)

[rum1887]

@lagru Do review this :)

[lagru]

Looks great and almost ready! Except for the comment on capitalization I'm happy to approve.

[rum1887]

Looks great and almost ready! Except for the comment on capitalization I'm happy to approve.

Done :)

[lagru]

Agreed, done. :) Thank you @rum1887!

[lagru]

Hey @mkcor, taking the liberty to ping you here. I think this can be merged or is nearly done depending on your review. 😉

[mkcor]

Very nice docstring!! Thanks, @rum1887. I just have a pending question, because I was surprised on a formal level...

@lagru thanks for pinging me!

[mkcor]

Usually (see all the rest above), what's under 'Examples' are specific (linked to) functions or classes... Why are 'inverse transforms' in the wild like this? 😉

[lagru]

Probably because there are multiple iradon* function's to link to and it wasn't clear which one. I would probably just link iradon as a well-known example.

[rum1887]

Probably because there are multiple iradon* function's to link to and it wasn't clear which one. I would probably just link iradon as a well-known example.

Usually (see all the rest above), what's under 'Examples' are specific (linked to) functions or classes... Why are 'inverse transforms' in the wild like this? 😉

yeah , was not sure which inverse transform to link to , so didn't link to keep it more general.
Since these are just examples , linking to a well known function would also work.

Thanks a lot for your review , learnt a lot and had a great time working on this !

[lagru]

Thanks @rum1887!