Skip to content
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.

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

Implement docstrings for all functions #1

Open
Ludee opened this issue Dec 5, 2017 · 0 comments
Open

Implement docstrings for all functions #1

Ludee opened this issue Dec 5, 2017 · 0 comments
Assignees

Comments

@Ludee
Copy link
Contributor

Ludee commented Dec 5, 2017

We are using NumPy Style Docstrings.
See: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html#example-numpy

example:

def example_method(self, param1, param2):
        """Class methods are similar to regular functions.

        Note
        ----
        Do not include the `self` parameter in the ``Parameters`` section.

        Parameters
        ----------
        param1
            The first parameter.
        param2
            The second parameter.

        Returns
        -------
        bool
            True if successful, False otherwise.

        """
        return True
Ludee added a commit that referenced this issue Dec 5, 2017
Ludee added a commit that referenced this issue Dec 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants