__call__ explained with example

[hiren-2911]

Description

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

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.

[pep8speaks]

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

• In the file skimage/transform/_geometric.py:

Line 624:1: W293 blank line contains whitespace

Comment last updated at 2021-05-20 07:34:17 UTC

[mkcor]

Hello @hiren-2911,

Thank you for your interest in the library! It looks like the description you've added is copied-pasted from popular Python courses. It's generic, not specific to geometric transformations. What is your intention with this contribution?

To include examples in a docstring, please refer these docs for the syntax to use.

Thanks again,
Marianne

[hiren-2911]

I am really sorry for my previous commits, I am contributing to open source for the first time and I was totally unaware.
Moreover I misunderstood the issue and gave a generic example instead of proving the legit example.

[alexdesiqueira]

Hello @hiren-2911,
thank you for taking the time to tackle #5309!
Would you like to check _geometric.py? It can help you when designing that example.
Thanks again!

[mjmdavis]

Perhaps the class comment could say:

"""
...
Instances of ProjectiveTransform are callable.
"""

[hmaarrfk]

Suggested change

	B=A(coords) #calling instance A as a function
	>>> B = A(coords) # calling instance A as a function
	>>> print(B)

can you provide the output of B?

[mkcor]

Unresolving conversation because I don't see the output of B anywhere...

[mkcor]

Suggested change

	to behave like functions. The user can call
	these instances like functions.
	to behave like a function.

Formatting-wise, I don't think lines need to be that short. Content-wise, have you seen the comments by @alexdesiqueira and @mjmdavis?

[mkcor]

Suggested change

	>>> B = A(coords) # calling instance A as a function
	>>> B = A(coords) # call instance A as a function

[mkcor]

Suggested change

	>>> A = ProjectiveTransform(matrix) # instance created.
	>>> A = ProjectiveTransform(matrix) # create instance

(for the sake of consistency)

[mkcor]

What is this line doing out here?

[lagru]

Hey @hiren-2911, thank you for the contribution so far! Do you intend to and are you able to continue working on this?

[hiren-2911]

Yeah sure, I will be happy to contribute. Regards, Hiren Vaghela

…

On Fri, 10 Mar 2023 at 3:30 PM, Lars Grüter ***@***.***> wrote: Hey @hiren-2911 <https://github.com/hiren-2911>, thank you for the contribution so far! Do you intend to and are you able to continue working on this? — Reply to this email directly, view it on GitHub <#5390 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AOAQIUE2POB7J665VCX3YTTW3L3S7ANCNFSM44YTOXNA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[lagru]

Additionally, it doesn't look like the docstring of methods such as __call__ is rendered in our current HTML (see rendering of ProjectiveTransform). I'd propose to move the example section to the class docstring.