Code

Streamline Docstrings#235

Code

Merged

CodyCBakerPhD merged 39 commits intomaincatalystneuro/roiextractors:mainfrom pydocstylecatalystneuro/roiextractors:pydocstyleCopy head branch name to clipboardSep 7, 2023

+1,643-359

Commits

Commits on Aug 22, 2023

• add pydocstyle to pre-commit hooks

  pauladkisson

  committed
  1ca8add

  Copy full SHA for 1ca8add

• add docstrings to suite2p

  pauladkisson

  committed
  c82ac6f

  Copy full SHA for c82ac6f

Commits on Aug 23, 2023

• add docstrings to hdf5

  pauladkisson

  committed
  d1d99e7

  Copy full SHA for d1d99e7

• add docstrings to sima

  pauladkisson

  committed
  7ea3d82

  Copy full SHA for 7ea3d82

• added docstrings to nwbextractors

  pauladkisson

  committed
  f7998d7

  Copy full SHA for f7998d7

• added docstrings to base segementation extractor

  pauladkisson

  committed
  766f242

  Copy full SHA for 766f242

Commits on Aug 24, 2023

• ignore missing docstrings in pre-commit (D102)

  pauladkisson

  committed
  ab5043f

  Copy full SHA for ab5043f

• ignore missing docstrings in pre-commit (D1) and enforce numpydoc style

  pauladkisson

  committed
  020f873

  Copy full SHA for 020f873

• remove #noqa's

  pauladkisson

  committed
  e9f451b

  Copy full SHA for e9f451b

Commits on Aug 25, 2023

• prototype script to find functions w/o docstrings (including inheritance)

  pauladkisson

  committed
  5dddabe

  Copy full SHA for 5dddabe

Commits on Aug 30, 2023

• refactored docstring check into pytest script and moved to tests

  pauladkisson

  committed
  7fabffa

  Copy full SHA for 7fabffa

• added docstrings to base imaging extractor

  pauladkisson

  committed
  fb49473

  Copy full SHA for fb49473

• updated imagingextractor.py docstring

  pauladkisson

  committed
  19150b2

  Copy full SHA for 19150b2

Commits on Aug 31, 2023

• removed redundant docstrings in suite2p

  pauladkisson

  committed
  c3ef801

  Copy full SHA for c3ef801

• removed redundant docstrings in hdf5

  pauladkisson

  committed
  b2955f7

  Copy full SHA for b2955f7

• removed redundant docstrings in sima

  pauladkisson

  committed
  6b21e1c

  Copy full SHA for 6b21e1c

• removed redundant docstrings in nwb

  pauladkisson

  committed
  3d631bc

  Copy full SHA for 3d631bc

• fixed _columns vs _num_cols bug

  pauladkisson

  committed
  8023d52

  Copy full SHA for 8023d52

• added docstrings to multiimagingextractor

  pauladkisson

  committed
  fa2589e

  Copy full SHA for fa2589e

• added docstrings to multisegmentationextractor

  pauladkisson

  committed
  09b0026

  Copy full SHA for 09b0026

• added docstrings to caiman

  pauladkisson

  committed
  d4d380c

  Copy full SHA for d4d380c

• added docstrings to caiman

  pauladkisson

  committed
  ba33b96

  Copy full SHA for ba33b96

• added docstrings to memmap

  pauladkisson

  committed
  0d8e86f

  Copy full SHA for 0d8e86f

• added docstrings to miniscope

  pauladkisson

  committed
  9299281

  Copy full SHA for 9299281

• added docstrings to numpy

  pauladkisson

  committed
  3d928a6

  Copy full SHA for 3d928a6

• added docstrings to scanbox image

  pauladkisson

  committed
  e574d8f

  Copy full SHA for e574d8f

• added docstring to multisegmentationextractor decorator

  pauladkisson

  committed
  30f71fb

  Copy full SHA for 30f71fb

Commits on Sep 1, 2023

• added docstrings to EXTRACT and CNMF-E

  pauladkisson

  committed
  cf6ef62

  Copy full SHA for cf6ef62

• added docstrings to Tiff

  pauladkisson

  committed
  bbb7d45

  Copy full SHA for bbb7d45

Commits on Sep 5, 2023

• added docstrings to extraction_tools

  pauladkisson

  committed
  b87b071

  Copy full SHA for b87b071

• fixed docstring checker to ignore dataclass methods

  pauladkisson

  committed
  1167d13

  Copy full SHA for 1167d13

• added docstrings to package __init__s

  pauladkisson

  committed
  78562a0

  Copy full SHA for 78562a0

• fixed bug in docstring test

  pauladkisson

  committed
  89b146e

  Copy full SHA for 89b146e

• added docstrings to toy_example

  pauladkisson

  committed
  6a1a83f

  Copy full SHA for 6a1a83f

• added docstrings to helper functions in tiffimagingextractors

  pauladkisson

  committed
  c3529d6

  Copy full SHA for c3529d6

• added docstrings to testing

  pauladkisson

  committed
  295f0c1

  Copy full SHA for 295f0c1

• added docstrings to testing

  pauladkisson

  committed
  957c53c

  Copy full SHA for 957c53c

Commits on Sep 6, 2023

• TODO for mode parameter in toy_example

  pauladkisson

  committed
  47eaa3d

  Copy full SHA for 47eaa3d

Commits on Sep 7, 2023

• removed docstring test to simplify PR

  pauladkisson

  committed
  2769b8e

  Copy full SHA for 2769b8e