brbzull0 commented on code in PR #13609:
URL: https://github.com/apache/trafficserver/pull/13609#discussion_r3965921117


##########
doc/developer-guide/jsonrpc/jsonrpc-architecture.en.rst:
##########
@@ -74,6 +74,9 @@ Our JSONRPC  protocol implementation uses lib yamlcpp for 
parsing incoming and o
 this allows the server to accept either JSON or YAML format messages which 
then will be parsed by the protocol implementation. This seems handy
 for user that want to feed |TS| with existing yaml configuration without the 
need to translate yaml into json.
 
+The server emits null values as the literal ``null``, not as YAML's ``~``. 
JSON parsers reject ``~``. YAML resolves ``~`` and
+``null`` to the same value. Clients that read the response as YAML see no 
change, and the server still accepts YAML input.

Review Comment:
   Measured before declining. The two lines this comment covers are 125 and 122 
characters. The lines around them, which this PR does not touch, are 143, 130 
and 130, and the file's longest lines (144, twice) predate the branch. Sibling 
documents in the same directory run longer still: 162 in 
`jsonrpc-handler-development.en.rst` and 200 in `jsonrpc-api.en.rst`.
   
   There is also no RST line-length rule here to violate. There is no `doc8`, 
`rstcheck` or `rstfmt` configuration anywhere in the tree, and 
`tools/git/pre-commit` does not inspect `.rst` files at all. The 
`max-line-length = 132` in `setup.cfg` is flake8's, and applies to Python.
   
   Leaving the paragraph as it stands, since it is already shorter than the 
text surrounding it.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to