Skip to content

Commit fb63f71

Browse files
committed
Add python coding rules to .cursorrules
1 parent ce68524 commit fb63f71

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

.cursorrules

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@
33
# General
44
- Use English as the default language unless specified otherwise.
55

6+
# Python Coding Rules
7+
8+
## Python files should have module-level docstrings
9+
- All .py files should start with a module-level docstring that describes the purpose and contents of the module
10+
- The docstring should be enclosed in triple quotes (""")
11+
- The first line should be a brief summary
12+
- Following lines (if needed) should provide more detailed description after a blank line
13+
614
# Testing
715
- Use unittest module for testing
816
- In tests, execution-related code like the following is unnecessary:

0 commit comments

Comments
 (0)