[PATCH] D17602: [clang-tidy] update links to Google Code Style in docs

Haojian Wu via cfe-commits cfe-commits at lists.llvm.org
Thu Feb 25 06:26:53 PST 2016


hokein added inline comments.

================
Comment at: docs/clang-tidy/checks/readability-named-parameter.rst:13
@@ -13,2 +12,3 @@
+https://google.github.io/styleguide/cppguide.html#Function_Declarations_and_Definitions
 
 All parameters should be named, with identical names in the declaration and
----------------
omtcyf0 wrote:
> alexfh wrote:
> > omtcyf0 wrote:
> > > It is rst. I meant generated HTML docs there.
> > > 
> > > IIRC rst is similar to markdown there -- the generated output won't have newline there unless there are 2 spaces at the end of line or a blank line.
> > One of the good properties of markdown and rst (though rst is worse in this regard) is that these formats are readable and usable as a plain text (unlike HTML, for example). Breaking the link makes the link unusable in the text mode (at least, not with vim in a terminal).
> Okay, won't do that again :)
> IIRC rst is similar to markdown there -- the generated output won't have newline there unless there are 2 spaces at the end of line or a blank line.

Indeed, the generated html will not have a new line, but the link will be broken.


http://reviews.llvm.org/D17602





More information about the cfe-commits mailing list