You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,17 @@
1
1
# 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.
3
3
4
4
* Support for Python-code (support for C-code is planned).
5
5
* 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
7
7
methods.
8
8
9
9
## Getting Started
10
10
You can begin extracting and converting docstrings using the command line tool
11
11
`mydocstring` that comes with package. Simply type `mydocstring --help` to see how to use it.
12
12
13
13
Let's extract the docstring from the following example code and convert it to
14
-
markdown:
14
+
Markdown:
15
15
```python
16
16
defexample_function(arg1, arg2=1):
17
17
"""
@@ -31,7 +31,7 @@ A more detailed example code is found in [examples/example.py](examples/example.
0 commit comments