icenet-ai / icenet

The icenet library is a pip installable python package containing the commands and code you need to produce forecasts
MIT License
20 stars 6 forks source link

Standardisation on styling, docs and commenting #20

Open JimCircadian opened 2 years ago

JimCircadian commented 2 years ago

There's a need to go through and do the following, and reference/add reference to an appropriate style guide

JimCircadian commented 5 months ago

@bnubald for this issue, let's have a chat about the format for docstrings: I've updated the above description to not specify directly (whoops) - changing all the sphinx docstrings wasn't what I intended, but the sphinx style was used probably after I raised this issue... ;)

JimCircadian commented 5 months ago

@bnubald on further deliberation I've not changed anything you've updated! 😉