Add DOCSTRINGS - Githubissues

ancrebo / https-github.com-corentinprados-Q_event_DRL_control

0 stars 0 forks source link

Add DOCSTRINGS #20

Open Quelthezar opened 1 month ago

Quelthezar commented 1 month ago

Should be consistent with style - perhaps Google style? Numpy/Scipy style? Up for discussion!

PRIORITIES:

[x] alya.py
[x] Env3D_MARL_channel.py
[x] env_utils.py
[x] jets.py
[x] logging_config.py
[x] witness.py
[x] PARALLEL_TRAINING_3D_CHANNEL_MARL.py

SECONDARY:

[x] coco_calc_reward.py
[ ] coco_calc_avg_vel.py
[ ] calc_avg_qvolume.py
[ ] cr.py
[ ] extract_forces.py
[ ] visualization.py

Quelthezar commented 1 month ago

From discussion, we will use Numpy style whenever possible - this includes module docstrings!