Code

Docstring compliance#323

Code

Merged

arik-shurygin merged 18 commits intomainCDCgov/DynODE:mainfrom docstring-complianceCDCgov/DynODE:docstring-complianceCopy head branch name to clipboardJan 16, 2025

+1,717-1,152

Commits

Commits on Jan 9, 2025

• checkpoint revamping comments on most of dynode except for utils and vis_utils

  arik-shurygin

  committed
  d0c160c

  Copy full SHA for d0c160c

Commits on Jan 10, 2025

• checkpoint more comment work

  arik-shurygin

  committed
  e492fd9

  Copy full SHA for e492fd9

Commits on Jan 11, 2025

• more conscise comments

  arik-shurygin

  committed
  d5e1f03

  Copy full SHA for d5e1f03

Commits on Jan 13, 2025

• fixing comments vis_utils

  arik-shurygin

  committed
  94215e9

  Copy full SHA for 94215e9

• comment concise abstract_parameters

  arik-shurygin

  committed
  57f52cb

  Copy full SHA for 57f52cb

• fixing return types of some methods and updating their docstrings (#325)

  Show description for b2a571f
  arik-shurygin

  authored
  b2a571f

  Copy full SHA for b2a571f

Commits on Jan 14, 2025

• checkpoint using pydocstyle to format comments on first four files, __init__.py, abstract_initializer.py, abstract_parameters.py, and config.py. Had to make many config functions private to avoid n…

  Show description for 8603a5b
  arik-shurygin

  committed
  8603a5b

  Copy full SHA for 8603a5b

• mypy bugfix

  arik-shurygin

  committed
  e5e315e

  Copy full SHA for e5e315e

• pydocstyle covid_sero_initializer.py

  arik-shurygin

  committed
  a4eb355

  Copy full SHA for a4eb355

• small tweaks to dynode_runner since many methods are being moved out in a different PR

  arik-shurygin

  committed
  6edceee

  Copy full SHA for 6edceee

• pydocstyle mechanistic_inferer.py

  arik-shurygin

  committed
  4b48f9b

  Copy full SHA for 4b48f9b

• pydocstyle mechanistic_runner.py

  arik-shurygin

  committed
  629b65b

  Copy full SHA for 629b65b

• pydocstyle static_value_parameters.py

  arik-shurygin

  committed
  fc12113

  Copy full SHA for fc12113

• pydocstyle utils.py

  arik-shurygin

  committed
  fd2c58e

  Copy full SHA for fd2c58e

• pydocstyle vis_utils.py

  arik-shurygin

  committed
  600c44f

  Copy full SHA for 600c44f

Commits on Jan 15, 2025

• Notes section does not need to be indented

  arik-shurygin

  committed
  6df70d2

  Copy full SHA for 6df70d2

• adding --convention=numpy flag to pydocstyle to also check numpy conventions of methods

  arik-shurygin

  committed
  d7757d7

  Copy full SHA for d7757d7

Commits on Jan 16, 2025

• note->notes in comment

  arik-shurygin

  committed
  d69b041

  Copy full SHA for d69b041