Skip to content

Commit 8b893bd

Browse files
author
ooreilly
authored
Update README.md
1 parent 4392ed6 commit 8b893bd

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# MyDocstring
2-
[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.
2+
[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.
33

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

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

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

3737
```

0 commit comments

Comments
 (0)