xgsa added inline comments.
================
Comment at: docs/clang-tidy/index.rst:280
+ lint-command
+ lint-command lint-args
+
----------------
aaron.ballman wrote:
> This should have a subscript `opt` following `lint-args` to denote that the
> args are optional. I think you can achieve that with:
> ```
> lint-args\ :sub:`opt`
> ```
Sorry, I am not very familiar with Sphinx, but
```
\ :sub:`opt`
```
seems doesn't work inside `parsed-literal` block (I have searched through the
llvm docs and found a few similar places, which uses such construction in
`parsed-literal` block, and it is not rendered properly even on official web
site).
Here `parsed-literal` block is used to render a quote-like block with custom
formatting, so the whole grammar is shown as a single entity, and I cannot
achieve this with the other constructs.
To show that `lint-args` is optional I split this grammar rule into 2:
```
lint-command
lint-command lint-args
```
Isn't it enough or are there any suggestions how to handle this?
https://reviews.llvm.org/D40671
_______________________________________________
cfe-commits mailing list
[email protected]
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
