Improve RAO class docstring - Githubissues

4Subsea / waveresponse-python

Vessel motion and wave utilities

https://docs.4insight.io/waveresponse/python/latest/

MIT License

12 stars 4 forks source link

Improve RAO class docstring #48

Closed vegard-solum-4ss closed 1 year ago

vegard-solum-4ss commented 1 year ago

This PR is related to user story DST-

Description

Improve RAO class docstring according to Harald's comments. Clarified the requirements for the dirs parameter.

Checklist

[ ] PR title is descriptive and fit for injection into release notes (see tips below)
[ ] Correct label(s) are used

PR title tips:

Use imperative mood
Describe the motivation for change, issue that has been solved or what has been improved - not how
Examples:
- Add functionality for Allan variance to sensor_4s.simulate
- Upgrade to support Python 9.10
- Remove MacOS from CI