Some updates to docstrings

OpenSourceEconomics / lcm

Solution and simulation of life cycle models in Python with GPU acceleration.

Apache License 2.0

16 stars 1 forks source link

Some updates to docstrings #20

Closed hmgaudecker closed 1 year ago

codecov[bot] commented 1 year ago

Codecov Report

Merging #20 (f4d267b) into main (25bef85) will not change coverage. The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main      #20   +/-   ##
=======================================
  Coverage   98.54%   98.54%           
=======================================
  Files          38       38           
  Lines        1851     1851           
=======================================
  Hits         1824     1824           
  Misses         27       27

Impacted Files	Coverage Δ
src/lcm/simulate.py	`98.19% <ø> (ø)`
src/lcm/function_evaluator.py	`97.36% <100.00%> (ø)`

review-notebook-app[bot] commented 1 year ago

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

hmgaudecker commented 1 year ago

@timmens, just a couple of small things that might be good to merge before they grow large...

I enabeled nbstripout again in the hooks and updated all of them in the process.
Hence, you can ignore all changes to notebooks
In function_evaluator, just a renaming of a loop variable, which had confused me before
Do check the docstring changes of simulate thoroughly to make sure that the docstring matches (future) behaviour. Janoś and I thought that we wrote what it should do, if you agree and that is not current behaviour, please open an issue.