1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-16 14:08:35 +08:00

Help: Minor grammar cleanups of CMAKE_CURRENT_FUNCTION* docs

This commit is contained in:
Craig Scott
2020-04-10 21:55:38 +10:00
parent bd580b7d56
commit d2b139687a
5 changed files with 6 additions and 5 deletions

View File

@@ -95,7 +95,7 @@ Unlike a function, the :variable:`CMAKE_CURRENT_FUNCTION`,
:variable:`CMAKE_CURRENT_FUNCTION_LIST_DIR`,
:variable:`CMAKE_CURRENT_FUNCTION_LIST_FILE`,
:variable:`CMAKE_CURRENT_FUNCTION_LIST_LINE` variables are not
set for macro.
set for a macro.
.. _`Argument Caveats`:

View File

@@ -2,5 +2,5 @@ CMAKE_CURRENT_FUNCTION
----------------------
When executing code inside a :command:`function`, this variable
contains the name of the current function. It can be used for
contains the name of the current function. It can be useful for
diagnostic or debug messages.

View File

@@ -2,7 +2,7 @@ CMAKE_CURRENT_FUNCTION_LIST_DIR
-------------------------------
When executing code inside a :command:`function`, this variable
contains the full directory of the listfile defining the current function.
contains the full directory of the listfile that defined the current function.
It is quite common practice in CMake that modules use some additional files
(e.g., templates to render). And the code typically did the following:

View File

@@ -2,4 +2,4 @@ CMAKE_CURRENT_FUNCTION_LIST_FILE
--------------------------------
When executing code inside a :command:`function`, this variable
contains the full path to the listfile declaring a current function.
contains the full path to the listfile that defined the current function.

View File

@@ -2,4 +2,5 @@ CMAKE_CURRENT_FUNCTION_LIST_LINE
--------------------------------
When executing code inside a :command:`function`, this variable
contains the line number in the listfile where a current function has defined.
contains the line number in the listfile where the current function
was defined.