[GitHub] [druid] suneet-s edited a comment on pull request #11628: Fix TRIM help broken in Console SQL Editor

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

suneet-s edited a comment on pull request #11628:
URL: https://github.com/apache/druid/pull/11628#issuecomment-906836158


   > > Are the backticks necessary in the docs? I think we want the hint to show up as `TRIM([BOTH | LEADING | TRAILING] [FROM] expr)`
   > 
   > Actually, backtick appear in description is not necessary too. Just like:
   > <img alt="Screen Shot 2021-08-26 at 11 44 49 AM" width="517" src="https://user-images.githubusercontent.com/24642075/130900539-cc6d8ab9-0448-48c0-9b3e-cfc687314af2.png">
   
   I actually think we want these backticks as it's showcasing it is a function in the description and not meant to be grammatically correct 
   
   > I delete it in this PR. Now it displayed like this:
   > <img alt="Screen Shot 2021-08-26 at 12 23 26 PM" width="512" src="https://user-images.githubusercontent.com/24642075/130900604-834197df-da03-414e-bc28-ef596a5336f3.png">
   > <img alt="Screen Shot 2021-08-26 at 12 23 11 PM" width="510" src="https://user-images.githubusercontent.com/24642075/130900607-dfe88616-c65a-4db5-aede-6496639c86a7.png">
   
   Overall this is a small thing - and I think this PR makes the hints better so I've approved the change. If it is easy to remove the backticks from the title, but not around a function - like in the example above; I personally think that would be better - but again it's not a blocker, so feel free to merge.


-- 
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: commits-unsubscribe@druid.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org