Skip to content

Add docstring to the core methods in the onc.py #9

Open
@kan-fu

Description

@kan-fu

For example this is for Discovery methods.

It is decided to use numpy style for the docstring. Useful link on the sphinx extension doc to auto generate doc from docstring.

Here is an example from pandas docstring guide.

  • Add a doctest file

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions