Skip to content

Everything documented in the API reference should have docstrings #525

Open
Open
Everything documented in the API reference should have docstrings#525
Labels
docseasy
Milestone
wishlist

Description

@bgrant
bgrant
opened on Jul 16, 2014

http://distarray.readthedocs.org/en/latest/distarray.html

If it's in this reference, it should have a docstring, including functions, classes, modules, and packages.

We're not doing too badly on this, but there are some exceptions.

Activity

  1. bgrant
    added
    docs
    on Jul 16, 2014
  2. bgrant
    added this to the 0.5 milestone on Jul 16, 2014
  3. bgrant
    changed the title [-]All functions documented in the API reference should have docstrings[/-] [+]Everything documented in the API reference should have docstrings[/+] on Jul 17, 2014
  4. kwmsmith
    modified the milestones: 0.5, 0.6, wishlist on Aug 8, 2014

  5. kwmsmith commented on Aug 8, 2014

    @kwmsmith
    kwmsmith
    on Aug 8, 2014
    Contributor

    This is nice to have, but has to take a back seat to core features.

  6. bgrant
    added
    easy
    on Aug 12, 2014

  7. bgrant commented on Aug 12, 2014

    @bgrant
    bgrant
    on Aug 12, 2014
    ContributorAuthor

    This would be an easy place for someone new to get started contributing.

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

    docseasy

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions