Skip to content

Commit 4905010

Browse files
authored
Update CONTRIBUTING.md
1 parent f1f57f8 commit 4905010

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,20 +81,20 @@ Write messages as complete sentences.
8181
- Identify the offending value, name, or path explicitly.
8282
- For a missing optional dependency, include the `pip install` command:
8383

84-
```
84+
```text
8585
<Package> is not installed. Install it with: pip install <package>
8686
```
8787

8888
If the package is a PyThaiNLP optional-dependency group, name the extra:
8989

90-
```
90+
```text
9191
<Package> is required for this feature.
9292
Install it with: pip install pythainlp[<extra>]
9393
```
9494

9595
- For an invalid argument value, name the parameter and show the received value:
9696

97-
```
97+
```text
9898
<param> must be <description>; got {value!r}
9999
```
100100

@@ -172,13 +172,13 @@ Warning messages should be clear, concise, and parseable:
172172
- Write messages as complete sentences ending with a period.
173173
- For deprecations, name the deprecated symbol and its replacement:
174174

175-
```
175+
```text
176176
<old_symbol> is deprecated; use <new_symbol> instead.
177177
```
178178

179179
- For skipped data or fallback behavior, describe what was skipped and why:
180180

181-
```
181+
```text
182182
Skipping <item> entry with <reason>: {value!r}
183183
```
184184

0 commit comments

Comments
 (0)