Skip to content

Add documentation on parameters to the documentation #53

@G0rocks

Description

@G0rocks

Have been looking a little into the documentation listed in the readme: https://marinlauber.github.io/Python-VPP/.
Since I'm defining another ship then I copied the example of the yacht in runVPP.py and there the sails are defined as:

        Main("MN1", P=16.60, E=5.60, Roach=0.1, BAD=1.0),
        Jib("J1", I=16.20, J=5.10, LPG=5.40, HBI=1.8),
        Kite("A2", area=150.0, vce=9.55),
        Kite("A5", area=75.0, vce=2.75),

I don't need the kites since the ship I'm generating a polar for does not have them but has 2 main sails and 2 jibs.
Looking for the phrases "sail", "main", "jib" or "kite", "roach", "BAD", "J", "LPG", "HBI", "area" or "vce" yielded no results whatsoever.

Searching for "p" actually resulted in 6 matches, all irrelevant.
"e" gave 2 results, both irrelevant.
"i" gave 2 irrelevant results.

Hovering over these parameters did yield some results, example:

Image But did not work for all of them: Image

Please add the documentation for these parameters either to the documentation of the project or so that it is possible to hover over the parameter and get an explanation for what they mean.
Thank you :)

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions