Skip to content

API server code health improvements #998

Open
@melange396

Description

@melange396

The covidcast API server code works well, but it can be improved with an eye toward extensibility and other future changes. A number of points of potential refinement exist, including:

  • Long and/or complex ternaries and comprehensions are pervasive and should be reduced and/or simplified -- code golf is not good for readability/maintainability
  • Many class, method, and variable names are not descriptive or are misleading, and should be clarified
  • Documentation in the code for explaining algorithms and implementation choices is very thin and should be expanded. Undocumented code understandability is further exacerbated by naming choices.
  • Type annotation/hinting is clunky and verbose, and often not necessary.

Metadata

Metadata

Assignees

No one assigned

    Labels

    api changeaffect the API and its responsescode healthreadability, maintainability, best practices, etcdocumentationrefactorSubstantial projects to make the code do the same thing, better.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions