FloatingArrayDesign / MoorDyn

a lumped-mass mooring line model intended for coupling with floating structure codes
https://moordyn.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
73 stars 42 forks source link

Make sure the docs are up to date with the current API #260

Open RyanDavies19 opened 1 month ago

RyanDavies19 commented 1 month ago

Hi @sanguinariojoe,

If you are opening up a PR soon can you make sure the docs examples are up to date with the current API (See #257, #259)?

Specifically the examples in the drivers section and in the initialization section.

I figure it'll be quicker for you to do it because you set those examples up.

sanguinariojoe commented 1 month ago

Regarding #259 (affecting the initialization section), the API entry is already there, on the dev branch though:

https://github.com/FloatingArrayDesign/MoorDyn/blob/dev/wrappers/python/moordyn/moordyn.py#L501

The problem is that the default MoorDyn readthedocs points towards dev, not master.

I will check the API and the docs anyway

RyanDavies19 commented 1 month ago

@sanguinariojoe Thanks!

sanguinariojoe commented 1 month ago

Fixing on #262