Naming Convention: Properties vs Methods

[madsbk]

We want consistent naming of class members that don’t take any arguments. The goal is to clearly distinguish between cheap, read-only attributes and potentially expensive operations.

Naming Convention:

Properties

• Definition: Cheap, read-only attributes.
• Python: Use @property.
• C++: Use noun-style naming.
  • Example:
    • Python: .size
    • C++: .size()

Methods

• Definition: Potentially expensive operations.
• Naming rule: Start with a leading verb.
• Both Python & C++: Use regular methods.
  • Example:
    • Python: .get_table_view()
    • C++: .get_table_view()

TODO:

• Rename C++ methods.
• Rename Python methods.
• Write a DEVELOPER_GUIDE.md.

[pentschev]

I don't think we necessarily need to rename C++ methods, as in C++ they clearly follow the same pattern already used by the stdlib.

[nirandaperera]

I think, we use some c++ class members publicly in a properties-like manner currently. Ex. Buffer::size. Ideally these should be constexpr methods, and class members should be converted to private.