Redo docstrings checklist.
Closed this issue · 0 comments
coledie commented
Format
"""
Short description
Parameters
------------
param: type
Description of variable
...
Returns
---------
type Description of return
Usage
-------
```python
...
\```
"""If is an ndarray, use ndarray[dim1, dim2](dtype if applicable).
- Not much of existing documentation is this specific but should be moving forward.
Top of file docstring be copy of most relevant object docstring.
Doc Checklist (All in one PR)
- Setup.py description outdated.
- Setup.py version "DEVELOPMENT" overwritten in main, remove but test install after.
- core/
- experiments/
- games/RL/
- games/MetaRL/
- logging/
- viz/
- meta/
- snn/input
- snn/modifier
- snn/neuron
- snn/readout
- snn/reward
- snn/synapse
- snn/weight - Note matrix must be ma.
- snn/network - Clear there is multiple network options.
- Link to relevant sections of readme in callback, trainingloop, logger, reader, ...
- np.ndarray type hints -> specific ndarray dtypes
Type Hint Checklist (All in one PR)
- core/
- experiments/
- games/RL/
- games/MetaRL/
- logging/
- viz/
- meta/
- snn/input
- snn/modifier
- snn/neuron
- snn/readout
- snn/reward
- snn/synapse
- snn/weight - Note matrix must be ma.
- snn/network - Clear there is multiple network options.