Skip to content

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

@enryH

Description

@enryH

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions