Skip to content

Commit d7a692f

Browse files
committed
Prohibit ASCII art in proto documentation
(I could easily be persuaded to make this a "should not", but it really is a bad idea.)
1 parent 513054d commit d7a692f

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

aip/general/0192.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,12 @@ Comments **should** use `code font` for field or method names and for literals
8484

8585
Raw HTML **must not** be used.
8686

87+
"ASCII art" attempts to present a diagram within the protos **must not** be
88+
used. The Markdown within the protos is consumed by a large number of renderers,
89+
and any ASCII art is very unlikely to be well-presented by all of them. If
90+
a diagram is useful in order to understand the API, include a link to a
91+
documentation page containing the diagram as an image.
92+
8793
### Cross-references
8894

8995
Comments **may** "link" to another component (service, method, message, field,

0 commit comments

Comments
 (0)