Skip to content

Commit c76a5da

Browse files
authored
Update README.md
1 parent b338c80 commit c76a5da

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ pip install python-docstring-markdown
2424
### Command Line
2525

2626
```bash
27-
python -m python_docstring_markdown <package_dir> <output_file>
27+
python -m python_docstring_markdown <package_dir> <output_path>
2828
```
2929

3030
Arguments:
31-
- `package_dir`: Path to your Python package directory
32-
- `output_file`: Path where the Markdown documentation file will be saved
31+
- `package_dir`: Path to your Python package directory.
32+
- `output_path`: Path where the Markdown documentation file will be saved. A path that ends in `.md` will result in a single file. A directory path will result in one `.md` per-module.
3333

3434
Example:
3535
```bash

0 commit comments

Comments
 (0)