Skip to content

Documentation standard? #97

Open
Open
@lsetiawan

Description

@lsetiawan

I notice that docstrings of functions and classes are a bit confusing. And issue #94 points out that there isn't really a built in documentation for the objects returned by the api calls.

After looking at various popular python libraries out there, it seems like a lot of them follows the Numpy/Scipy docstring documentation style.

@ocefpaf will set up ODM2PythonAPI documentation to follow a similar approach to Folium. Looking at the code it seems like this library also follows the numpy/scipy documentation style (@ocefpaf, please correct me if I'm wrong).

Given those circumstances, I propose that we use the numpy/scipy standard when documenting the code. What do you all think? @emiliom @ocefpaf @aufdenkampe @horsburgh @sreeder ?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions