Skip to content

Python documentation improvements #1415

@matt035343

Description

@matt035343

Using highpy in my project took a long time. Generally, I would say the Python documentation is sub-par. When the library method signatures only contains strings with types and no argument names (except for arg0, arg1, arg2...), it is really difficult to guess what parameters are accepted in the functions and in what order.
The C documentation, on the other hand, was reasonable and helped me a long way. But the C and Python libraries are not 1-to-1, so there was a bit of trial an error.

Improving the Python documentation would help people to adopt the solver. I would say the documentation at least needs to state all methods/functions and their signatures

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions