WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Runtime documentation #17

@andreww

Description

@andreww

It's worth looking at the runtime documentation generated from the docstrings of the various functions and packages. From a quick look I've noticed the following:

  • No doctoring in pyDis/__init__.py. Adding a docstring the top of this file would make help(pyDis) work. It need not be long. Just some text from the README file would probably do the job.
  • Add a word or to in docstrings to pyDis/pn/__init__.py and pyDis/atomic/__init__.py too. These can be really short.
  • From a quick and non-exhaustive look most of the rest of the function docstrings look fine to me.
  • Sometimes docstrings are missing from the top of modules.
  • Once you have chosen a license note this and add a one line copyright statement in the docstring at the top of each module. You don't need the full license text.

I'll add any other specific points below.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions