Skip to content

Commit 006963a

Browse files
authored
Update Copilot instructions with type specification notes
Added notes about potential false positives from the analyzer and references to Python type specifications.
1 parent 82e1d9f commit 006963a

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
Use it to assist the maintenance of 100% type completeness in
2020
the repo. Read its usage and information it generates at
2121
<https://github.com/PyThaiNLP/pythainlp/blob/dev/build_tools/analysis/README.md>.
22+
Mind that the analyzer can create false positives,
23+
please refer to Python tyep specification when in doubt.
2224

2325
## Project contribution guidelines
2426

@@ -225,6 +227,8 @@
225227
So the user can know exactly which module the data type comes from.
226228
- [ ] Try to achieve type completeness, according to
227229
<https://typing.python.org/en/latest/guides/libraries.html#type-completeness>.
230+
Also refer to Python type specification at
231+
<https://typing.python.org/en/latest/spec/>.
228232
- [ ] `requires-python` in pyproject.toml should reflect the minimum
229233
Python version supported by the project.
230234
- [ ] Do not introduce syntax or features that are not supported

0 commit comments

Comments
 (0)