Becksteinlab / kda

Python package used for the analysis of biochemical kinetic diagrams.

GNU General Public License v3.0

3 stars 1 forks source link

DOC, MAINT: Update `plotting.py` documentaion #54

Closed nawtrey closed 2 years ago

nawtrey commented 2 years ago

Description

Update docstrings for all functions in kda.plotting.py
Change parameter obj_list in _get_panel_dimensions to n_diagrams and update function calls. This better reflects how the function is used and allows for more clear documentation.
Close issue #46

codecov[bot] commented 2 years ago

Codecov Report

Merging #54 (c10ef4e) into master (db9cee9) will decrease coverage by 0.00%. The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master      #54      +/-   ##
==========================================
- Coverage   99.86%   99.86%   -0.01%     
==========================================
  Files           9        9              
  Lines         724      723       -1     
==========================================
- Hits          723      722       -1     
  Misses          1        1

Impacted Files	Coverage Δ
kda/plotting.py	`100.00% <100.00%> (ø)`

nawtrey commented 2 years ago

Things to check:

[x] All parameters are explained
[x] All returns are specified
[x] All original parameter descriptions are still accurate (make sure they make sense in the function's context)
[x] draw_ode_results docstring is still up-to-date

It looks like some of the returns are still not specified, so I'll have to fix those and push them in.

nawtrey commented 2 years ago

I went through and double-checked every docstring. Mostly small edits, but should be a lot cleaner and more representative now.

nawtrey commented 2 years ago

Okay, this LGTM. Merging.