What to state in docstring of scripts that are re-used in several rules?

rl-institut / oemof-B3

An open-source energy system model for Brandenburg/Berlin.

https://oemof-b3.readthedocs.io/

GNU Affero General Public License v3.0

9 stars 5 forks source link

Open jnnr opened 1 year ago

jnnr commented 1 year ago

Decide how to handle docstring when reusing script for several rules.

Until now, there are only two such cases:

plot_scalar_results and plot_joined_scalars are two rules that share the script plot_scalars.py.
upload_results_to_oep and upload_resources_to_oep are two rules that share the script upload_b3_data_to_oep.py.