Update README.md
Browse files
README.md
CHANGED
|
@@ -36,8 +36,10 @@ The goal of the DocuMint model is to generate docstrings that are concise (brief
|
|
| 36 |
|
| 37 |
### Direct Use
|
| 38 |
|
| 39 |
-
The DocuMint model can be used directly to generate high-quality docstrings for Python functions. Given a Python function definition, the model will output a docstring in the format
|
| 40 |
-
|
|
|
|
|
|
|
| 41 |
|
| 42 |
## Training Details
|
| 43 |
|
|
|
|
| 36 |
|
| 37 |
### Direct Use
|
| 38 |
|
| 39 |
+
The DocuMint model can be used directly to generate high-quality docstrings for Python functions. Given a Python function definition, the model will output a docstring in the format
|
| 40 |
+
```
|
| 41 |
+
"""<generated docstring>""".
|
| 42 |
+
```
|
| 43 |
|
| 44 |
## Training Details
|
| 45 |
|