Skip to content

Commit 7f87547

Browse files
authored
Update copilot-instructions.md
1 parent adbcbd4 commit 7f87547

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
@@ -205,6 +205,10 @@
205205
- [ ] Recheck necessity of `# noqa:` and `# type: ignore`.
206206
- [ ] Recheck docstring and documentation consistency with the code;
207207
They should match the updated type hints.
208+
- [ ] In docstring, use full qualified name for non-standard library types.
209+
For example, `numpy.ndarray` instead of `ndarray`;
210+
`pandas.DataFrame` instead of `pd.DataFrame`.
211+
So the user can know exactly which module the data type comes from.
208212
- [ ] requires-python in pyproject.toml should reflect the minimum
209213
Python version supported by the project.
210214
- [ ] Do not introduce syntax or features that are not supported

0 commit comments

Comments
 (0)