[BUG] Documentation is out of date and misleading

[paulf81]

Is there an existing issue for this?

• I have searched the existing issues

Current Behavior

FLASC documentation has fallen behind and has not been updated. Description of examples is inaccurate/incomplete, and some documentation (particularly pertaining to the energy_ratio module) need to be updated to reflect changes made in #80.

Expected Behavior

Updated documentation (and possibly README) to reflect current status of code.

[misi9170]

I'm pushing this to v2.0. v2.0 will have significant restructuring of FLASC, and it makes sense to delay building out documentation until then.

[ejsimley]

I was going to add a documentation issue, but then saw this one, so I'll just add my support here!

I noticed a lot of functions are missing docstrings throughout the code (one example is the turbine_analysis.northing_offset module), and some need to be updated (for example, in ws_pw_curve_filtering.filter_by_power_curve, the arguments ws_deadband and pow_deadband aren't described in the doctstring).

Several of us should probably choose a few modules each and do a thorough review of the code and add missing documentation before the release.

[paulf81]

I was going to add a documentation issue, but then saw this one, so I'll just add my support here!

I noticed a lot of functions are missing docstrings throughout the code (one example is the turbine_analysis.northing_offset module), and some need to be updated (for example, in ws_pw_curve_filtering.filter_by_power_curve, the arguments ws_deadband and pow_deadband aren't described in the doctstring).

Several of us should probably choose a few modules each and do a thorough review of the code and add missing documentation before the release.

100% agree, I think @misi9170 was also asking @rafmudaf how to generate API from docstrings so we should make sure to conform with that if we are going through the effort

[Bartdoekemeijer]

Good points -- and a lot of this is from my lack of discipline on documentation writing/maintenance! So please feel free to delegate some modules to me too.

[paulf81]

No problem! I think it's all learning as we go and thank you!!!

[misi9170]

Although this is partially addressed in #187, but I'm going to leave this open because I think there's still more to do here (the API documentation is not yet included, although we do have an open PR for this at #180)

[paulf81]

@misi9170 what do you think, in the 2.1 release we did update the docs a bit, maybe fair to close this issue and can open a new one as needed with specific documentation update requests?