From ad6f7c64937fd916ccdead77e88a33a05b5df54f Mon Sep 17 00:00:00 2001 From: Mason Daugherty Date: Thu, 5 Feb 2026 18:30:49 -0500 Subject: [PATCH] chore(infra): inline code docs guidelines for `AGENTS.md` (#35038) --- AGENTS.md | 1 + CLAUDE.md | 1 + 2 files changed, 2 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 3995040222f..d0313ce32db 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 3995040222f..d0313ce32db 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