mirror of
https://github.com/hwchase17/langchain.git
synced 2026-02-21 22:56:05 +00:00
chore(infra): inline code docs guidelines for AGENTS.md (#35038)
This commit is contained in:
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user