Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Rainyan authored Oct 31, 2023
1 parent b17e4a0 commit 0574a67
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This action will scan all your SourcePawn code files (specified by `--code_patte
## Usage
To get started, copy the *docs.yml* GitHub action from [the example](#Example).

The action will accept all of the optional arguments for the underlying *document.py* Python script (replace dashes with underlines for multi-word arguments):
The action will accept all of the optional arguments for the underlying *document.py* Python script (replace dashes with underlines for multi-word arguments) as input parameters:
```
usage: document.py [-h] [-C CODE_PATTERNS] [-D DOC_PATTERNS] [-H HEADER_PATTERNS] [--dry-run] [--encoding ENCODING] [--format-filename FORMAT_FILENAME] [--format-cvarname FORMAT_CVARNAME]
[--format-cvarprop FORMAT_CVARPROP]
Expand Down

0 comments on commit 0574a67

Please sign in to comment.