Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting methods - obj.method or obj.method() #3

Open
enryH opened this issue Apr 21, 2021 · 0 comments
Open

Documenting methods - obj.method or obj.method() #3

enryH opened this issue Apr 21, 2021 · 0 comments

Comments

@enryH
Copy link
Collaborator

enryH commented Apr 21, 2021

Should we document object methods or module functions using obj.method (module.function) or obj.method() (module.function()).

I prefer the former, Rita used the ladder.

notatin arguments
obj.method
module.function
as function are object itself (first-class citizens), they can be assigned. They are callable (or callable()!) which describes them.
obj.method()
module.function()
Suggests directly that they are callable and distinguishes them from other attributes.

I have seen both in the official documentation. I just think it will be good to be consistent.

Any opinion or good reference to elaborate the issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant