Skip to content

The agent engineering platform.

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

Mason Daughertyad6f7c64937f
diff --git a/AGENTS.md b/AGENTS.md
index 3995040222..d0313ce32d 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -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
diff --git a/CLAUDE.md b/CLAUDE.md
index 3995040222..d0313ce32d 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -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