chore(infra): inline code docs guidelines for AGENTS.md (#35038)

This commit is contained in:
Mason Daugherty
2026-02-05 18:30:49 -05:00
committed by GitHub
parent 7853b0ffcf
commit ad6f7c6493
2 changed files with 2 additions and 0 deletions

View File

@@ -192,6 +192,7 @@ def send_email(to: str, msg: str, *, priority: str = "normal") -> bool:
- Document all parameters, return values, and exceptions
- Keep descriptions concise but clear
- Ensure American English spelling (e.g., "behavior", not "behaviour")
- Do NOT use Sphinx-style double backtick formatting (` ``code`` `). Use single backticks (`` `code` ``) for inline code references in docstrings and comments.
## Additional resources

View File

@@ -192,6 +192,7 @@ def send_email(to: str, msg: str, *, priority: str = "normal") -> bool:
- Document all parameters, return values, and exceptions
- Keep descriptions concise but clear
- Ensure American English spelling (e.g., "behavior", not "behaviour")
- Do NOT use Sphinx-style double backtick formatting (` ``code`` `). Use single backticks (`` `code` ``) for inline code references in docstrings and comments.
## Additional resources