Skip to content

Variable and function naming #10

@cbedwards-dfw

Description

@cbedwards-dfw

https://phac-modelling-hub.github.io/dev-practices/projects/consistency.html

In the code style section, it may be worth including a suggestion to think about consistent name types, in addition to the conventions like case type. For example, we try to have all function names begin with a verb. A user might choose to always include the data type in a suffix (e.g. penguins_df, turtles_list, fish_vec). Whatever the convention, it can be really helpful in the long run to try to use the same one. Code is harder to read (and much easier to make mistakes when writing) if the names are a mix of styles (e.g., penguins_df, list_turtles, data_vec_fish).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions