Skip to content

Docstring and documentation updating discussion issue #116

Description

@bordenc

I want to try PyDocumenting the source. Before I start, I want to know if anyone else is doing this so we don't replicate work/step on each other's toes. From my reading, docstrings should follow the Sphinx docstring format so we can Sphinx-compile the documentation into a nice purdy format.

A good body of PEP-8-conforming docstrings will support the programmers-guide, which should only need to glue the docstring bits together, kinda like how existing Python documentation currently works.

Discuss.

Activity

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

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