Skip to content

Document code and style conventions #237

@lightclient

Description

@lightclient

We should formalize any coding or style decisions not covered by black into a document somewhere in the repository.

For now, this issue can be a temporary place to collect these kind of decisions:

  • Name functions with short imperative phrases, avoiding extra words which don't add information (choose fetch instead of do_fetch).
  • Use exceptions for errors which are handled in-protocol (ex. OutOfGas).
  • Use ensure(...) for checking conditions at runtime.
  • Use assert only for type checking and bug catching.
  • Never use type: ignore unless absolutely necessary.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docArea: documentationC-enhanceCategory: a request for an improvementE-easyExperience: easy, good for newcomers

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions