Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ooreilly authored Jan 3, 2018
1 parent 4392ed6 commit 8b893bd
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# MyDocstring
[MyDocstring](README.md) is a small Python package that allows you to extract docstrings display them as either plain-text, [markdown](http://commonmark.org/), or [JSON](https://www.json.org/) data.
[MyDocstring](README.md) is a small Python package that allows you to extract docstrings display them as either plain-text, [Markdown](http://commonmark.org/), or [JSON](https://www.json.org/) data.

* Support for Python-code (support for C-code is planned).
* Support for [Google-style docstrings](http://google.github.io/styleguide/pyguide.html)
* Produces [JSON](https://www.json.org/), plain-text, and [markdown](http://commonmark.org/) output for modules, classes, functions, and
* Produces [JSON](https://www.json.org/), plain-text, and [Markdown](http://commonmark.org/) output for modules, classes, functions, and
methods.

## Getting Started
You can begin extracting and converting docstrings using the command line tool
`mydocstring` that comes with package. Simply type `mydocstring --help` to see how to use it.

Let's extract the docstring from the following example code and convert it to
markdown:
Markdown:
```python
def example_function(arg1, arg2=1):
"""
Expand All @@ -31,7 +31,7 @@ A more detailed example code is found in [examples/example.py](examples/example.
$ docstring examples/example.py example_function --markdown > examples/example_py.md
```
Go to [examples/example_py.md](examples/example_py.md) to
view the output. If you are not satisfied with the resulting markdown, you can provide your own
view the output. If you are not satisfied with the resulting Markdown, you can provide your own
[mako](http://makotemplates.org) template

```
Expand Down

0 comments on commit 8b893bd

Please sign in to comment.