Skip to content

Commit

Permalink
Fix usage message.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ossian O'Reilly committed Jan 3, 2018
1 parent fe2bc89 commit 9c03526
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions mydocstring/docstring.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
"""
docstringout
mydocstring
Usage:
docstringout <file> <name> [-tmj] [-T=<tpl>]
docstringout -h | --help
docstringout --version
mydocstring <file> <name> [-tmj] [-T=<tpl>]
mydocstring -h | --help
mydocstring --version
Options:
-h --help Show help (this screen).
Expand All @@ -16,13 +16,13 @@
Examples:
Extract the module docstring
docstring module.py . --markdown
mydocstring module.py . --markdown
Extract a module function docstring
docstring module.py function --markdown
mydocstring module.py function --markdown
Extract a class docstring
docstring module.py Class --markdown
mydocstring module.py Class --markdown
Extract a method docstring
docstring module.py Class.method --markdown
mydocstring module.py Class.method --markdown
Help:
Please see the issue tracker for the Github repository:
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from setuptools import setup

setup(name='mydocstring',
version='0.1.1',
version='0.1.2',
description="""A tool for extracting and converting Google-style docstrings to
plain-text, markdown, and JSON.""",
url='http://github.com/ooreilly/mydocstring',
Expand Down

0 comments on commit 9c03526

Please sign in to comment.