willow-rs icon indicating copy to clipboard operation
willow-rs copied to clipboard

Remove `.get` fn names, use third-person in docs

Open Frando opened this issue 6 months ago • 1 comments

Hi, while starting to work with willow-rs I noted some things where the codebase differs from the rust naming conventions and documentation conventions:

  • In function docs willow-rs uses imperative ("Create a new path") whereas the rust conventions use third person ("Creates a new path")
  • A few methods are prefixed with get_, which is discouraged in the conventions. So Path::component_count instead of Path::get_component_count

If there aren't strong reasons for deviating from the convention, I found it to be quite helpful in my coding experience to just stick with it for general consistency and bikeshed avoidance.

Frando avatar Aug 10 '24 14:08 Frando