Skip to content

Commit

Permalink
Fix missed parameters and add parameters back that should not have be…
Browse files Browse the repository at this point in the history
…en removed
  • Loading branch information
zachcran committed May 22, 2023
1 parent 8942935 commit f89a8cd
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions cmake_test/detail_/utilities/print_result.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ include(cmake_test/detail_/utilities/repeat_string)

#[[[ Wraps the process of printing a test's result
#
# This function largely serves as code factorization for ``print_pass`` and
# ``print_fail``. This function will print an indent appropriate for the
# This function largely serves as code factorization for ``_ct_print_pass`` and
# ``_ct_print_fail``. This function will print an indent appropriate for the
# current nesting, and then enough dots to right align the result.
#
# :param name: The name of the test we are printing the result of.
Expand Down
2 changes: 1 addition & 1 deletion cmake_test/detail_/utilities/repeat_string.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ include(cmake_test/detail_/utilities/return)
# :type result: Identifier
# :param str: The substring to repeat.
# :type str: str
# :param _rs_n: The number of times to repeat ``${_rs_str}``.
# :param n: The number of times to repeat ``${str}``.
# :type n: str
# :returns: A string containing the created string. The result is accessible to
# the caller via ``result``.
Expand Down
8 changes: 4 additions & 4 deletions cmake_test/detail_/utilities/return.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ include_guard()
# The best way to do this is to have the callee provide the function with an
# identifier to save the result to. This function wraps the common case where
# internally the function saves the result to a local variable with the same
# name as the callee provided for the result. Without the ``return``
# name as the callee provided for the result. Without the ``_ct_return``
# function this pattern looks something like:
#
# .. code-block:: cmake
Expand All @@ -30,7 +30,7 @@ include_guard()
# set(${return_identifier} ${${return_identifier}} PARENT_SCOPE
# endfunction()
#
# With the ``return`` function the above becomes:
# With the ``_ct_return`` function the above becomes:
#
# .. code-block:: cmake
#
Expand All @@ -49,8 +49,8 @@ include_guard()
#
# This function is a macro to avoid creating another scope. If ``function``
# is used the identifier will be set in the scope of the function that
# called ``return`` and NOT in the scope of the function that called the
# callee of ``return``.
# called ``_ct_return`` and NOT in the scope of the function that called the
# callee of ``_ct_return``.
#]]
macro(_ct_return _r_var)
set(${_r_var} "${${_r_var}}" PARENT_SCOPE)
Expand Down

0 comments on commit f89a8cd

Please sign in to comment.