New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generate API using pre-commit #19

Merged

malmans2 merged 3 commits into JMMP-Group:main from malmans2:docs

Feb 9, 2022

Member

malmans2 commented Feb 9, 2022 •

edited

Loading

Closes #18
I added a pre-commit task that generates docs/api.md.
Nothing fancy, but shows all documented functions.

The only caveat is that we have to use google-style docstrings rather than numpy-style:
Example:

def function(param1: int, param2: str) -> bool:
    """Example function.

    Args:
        param1: The first parameter.
        param2: The second parameter.

    Returns:
        The return value. True for success, False otherwise.
    """

malmans2 added 3 commits

February 8, 2022 22:08


          add pre-commit to create api

8994a11


          add typing

d1489b5


          better docs

03719f8

Member Author

malmans2 commented Feb 9, 2022

Merging to test, looks like workflows are not working from external forks

malmans2 merged commit 86642ab into JMMP-Group:main

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet