Skip to content

Potential code style / readability issues #571

@rHorsey

Description

@rHorsey

Topics for future discussions regarding standard coding practices for the team. These would each be a departure from the status quo, so I don't want to impose them unless we really think collectively they're worthwhile.

  • Thoughts on list comprehension, particularly formatting for multiline implementations.
  • Use of guarded try/except blocks vs if/elsif/else raise vs {}.get() functions. There are both logic and performance implications of this, but the logic ones are the ones I want to focus on for the time being.
  • More substantial documentation of allowed / expected values within dicts or lists in function docstrings. This pairs to some extent with my goal for more comprehensive schemas across the board.
  • Far more substantial documentation of null / default / empty arrays or dictionaries.

These are each things I'd like to discuss in our next monthly meeting, but are not time sensitive or a reason to delay PRs (at least not until / unless we decide to change our default expectations.)

Cheers,

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions