Skip to content

Commit 1940334

Browse files
authored
Fix formatting and clarify Python version requirements
1 parent 146b64d commit 1940334

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

.github/copilot-instructions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -225,17 +225,17 @@
225225
So the user can know exactly which module the data type comes from.
226226
- [ ] Try to achieve type completeness, according to
227227
<https://typing.python.org/en/latest/guides/libraries.html#type-completeness>.
228-
- [ ] requires-python in pyproject.toml should reflect the minimum
228+
- [ ] `requires-python` in pyproject.toml should reflect the minimum
229229
Python version supported by the project.
230230
- [ ] Do not introduce syntax or features that are not supported
231231
by the specified minimum Python version,
232232
unless it is supported via `__future__` imports.
233-
- [ ] Do not use | union type syntax if minimum Python version is
234-
below 3.10.
235-
- [ ] Make sure that the module/class/function/object can be properly used by
233+
- [ ] Do not use `A | B` union type syntax anywhere if minimum Python version is
234+
below 3.10.
235+
- [ ] Make sure that the type annotations can be properly used by
236236
runtime type inspection tools, documentation generators, and static
237-
analysis tools.
238-
For example, typing.get_type_hints() should work properly.
237+
analysis tools. For example, `typing.get_type_hints()` and
238+
`inspect` should work properly.
239239
- [ ] Do not allow the use of assert in production code
240240
(it is only allowed for testing and debugging).
241241
- [ ] Do not use mutable default arguments in function/method definitions.

0 commit comments

Comments
 (0)