From 8c25ae37df5c5fa39970e2d367de0c88488b47b3 Mon Sep 17 00:00:00 2001
From: Josh Triplett <josh@joshtriplett.org>
Date: Wed, 28 Feb 2024 13:31:05 -0800
Subject: [PATCH] style-guide: Note that we don't account for comments in every
 possible place

---
 src/doc/style-guide/src/README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/doc/style-guide/src/README.md b/src/doc/style-guide/src/README.md
index dce50ebf29c46..6d221765a3528 100644
--- a/src/doc/style-guide/src/README.md
+++ b/src/doc/style-guide/src/README.md
@@ -209,6 +209,10 @@ given:
 The following guidelines for comments are recommendations only, a mechanical
 formatter might skip formatting of comments.
 
+The style guide does not account for every possible placement of comments.
+Placing a comment in unexpected places (e.g. between `pub` and `fn` in `pub
+fn`) may result in suboptimal "best effort" formatting by a formatter.
+
 Prefer line comments (`//`) to block comments (`/* ... */`).
 
 When using line comments, put a single space after the opening sigil.