[PATCH] Adding user documentation for UseAuto transform

Dmitri Gribenko gribozavr at gmail.com
Fri Mar 8 11:38:44 PST 2013


  LGTM, but consider the suggested wording improvements.


================
Comment at: docs/UseAutoTransform.rst:10
@@ +9,3 @@
+transform is enabled with the :option:`-loop-convert` option of
+:program:`cpp11-migrage`. For example:
+
----------------
Typo: migrate.

================
Comment at: docs/UseAutoTransform.rst:20-22
@@ +19,5 @@
+
+The ``auto`` type specifier will only be introduced in situations where the
+type specifier of the variable declaration matches the type of the initializer
+expression. However, not every situation should be transformed:
+
----------------
Maybe:
... where the variable type matches the type of the initializer expression.  In other words, `auto` should deduce the same type that was spelled in the source.

================
Comment at: docs/UseAutoTransform.rst:61
@@ +60,3 @@
+situations:
+* The iterator is for one of the C++ Specification-defined containers from the ``std`` namespace:
+
----------------
Maybe better:
The iterator is for a standard container in std namespace.

================
Comment at: docs/UseAutoTransform.rst:59-60
@@ +58,4 @@
+
+The transform will only replace iterator type-specifiers in the following
+situations:
+* The iterator is for one of the C++ Specification-defined containers from the ``std`` namespace:
----------------
... when all of the following conditions are satisfied?


http://llvm-reviews.chandlerc.com/D508

BRANCH
  docs

ARCANIST PROJECT
  clang-tools-extra



More information about the cfe-commits mailing list