Shorten stdio test comments (#3329)
This commit is contained in:
parent
b2025ab815
commit
0d92192765
1 changed files with 62 additions and 262 deletions
|
|
@ -45,6 +45,8 @@ assigned to their author are closed automatically.
|
|||
|
||||
## Code Quality
|
||||
|
||||
- Keep comments brief. Explain only non-obvious reasons or constraints; do not
|
||||
narrate the code or restate names, types, or assertions.
|
||||
- Type hints required for all code
|
||||
- Public APIs must have docstrings. When a public API raises exceptions a
|
||||
caller would reasonably catch, document them in a `Raises:` section. Don't
|
||||
|
|
|
|||
Loading…
Reference in a new issue