[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4345: Substitute tab for leading 4 spaces in documentation

[GitBox <gi...@apache.org>]

ocket8888 commented on a change in pull request #4345: Substitute tab for leading 4 spaces in documentation
URL: https://github.com/apache/trafficcontrol/pull/4345#discussion_r372003162
 
 

 ##########
 File path: docs/source/admin/quick_howto/anonymous_blocking.rst
 ##########
 @@ -33,9 +33,9 @@ Configure Anonymous Blocking
 			"name": "Anonymous IP Blocking Policy",
 
 			"anonymousIp": { "blockAnonymousVPN": true,
-			                 "blockHostingProvider": true,
-			                 "blockPublicProxy": true,
-			                 "blockTorExitNode": true},
+				"blockHostingProvider": true,
+				"blockPublicProxy": true,
+				"blockTorExitNode": true},
 
 Review comment:
   This was actually alignment, not indentation. The intent is to line up all the text - and that's totally valid because the example block is properly indented so the contents are not interpreted by the RST compiler at all (they are lex'd by Pygments but this is lexically and syntactically correct JSON so that doesn't matter either).
   
   It is more consistent to indent these rather than align them, but if you're gonna do that I'd ask that you also indent the top property (`"blockAnonymousVPN"`) so that everything still lines up, and also check the output to be sure it isn't being expanded wider than a typical browser window (because Sphinx auto-expands tabs in code examples to GNU-standard 8 spaces and I've already tried everything I can think of to fix that).

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services