From f478e59ad5e1981f6ef6097690865dd4ae33d2a3 Mon Sep 17 00:00:00 2001 From: Cody Balos Date: Wed, 13 Dec 2023 11:33:25 -0800 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Daniel R. Reynolds --- .../SUNAdaptController_Description.rst | 16 ++++++++-------- .../SUNAdaptController_ImExGus.rst | 2 +- .../SUNAdaptController_Soderlind.rst | 12 ++++++------ doc/shared/sunmemory/SUNMemory_CUDA.rst | 10 +++++----- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/shared/sunadaptcontroller/SUNAdaptController_Description.rst b/doc/shared/sunadaptcontroller/SUNAdaptController_Description.rst index b0e36f0030..d7bef1f890 100644 --- a/doc/shared/sunadaptcontroller/SUNAdaptController_Description.rst +++ b/doc/shared/sunadaptcontroller/SUNAdaptController_Description.rst @@ -147,7 +147,7 @@ note these requirements below. Additionally, we note the behavior of the base SU routine). :param C: the :c:type:`SUNAdaptController` object. - :return: :c:type:`SUNErrCode` indicating success or failure + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: @@ -166,7 +166,7 @@ note these requirements below. Additionally, we note the behavior of the base SU :param p: the current order of accuracy for the time integration method. :param dsm: the local temporal estimate from the previous step attempt. :param hnew: (output) the estimated step size. - :return: :c:type:`SUNErrCode` indicating success or failure + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: @@ -180,7 +180,7 @@ note these requirements below. Additionally, we note the behavior of the base SU of previous *dsm* or *h* values. :param C: the :c:type:`SUNAdaptController` object. - :return: :c:type:`SUNErrCode` indicating success or failure + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: @@ -193,7 +193,7 @@ note these requirements below. Additionally, we note the behavior of the base SU Sets the controller parameters to their default values. :param C: the :c:type:`SUNAdaptController` object. - :return: :c:type:`SUNErrCode` indicating success or failure + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: @@ -207,7 +207,7 @@ note these requirements below. Additionally, we note the behavior of the base SU :param C: the :c:type:`SUNAdaptController` object. :param fptr: the output stream to write the parameters to. - :return: :c:type:`SUNErrCode` indicating success or failure + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: @@ -224,7 +224,7 @@ note these requirements below. Additionally, we note the behavior of the base SU :param C: the :c:type:`SUNAdaptController` object. :param bias: the error bias factor -- an input :math:`\leq 0` indicates to use the default value for the controller. - :return: :c:type:`SUNErrCode` indicating success or failure + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: @@ -243,7 +243,7 @@ note these requirements below. Additionally, we note the behavior of the base SU :param C: the :c:type:`SUNAdaptController` object. :param h: the successful step size. :param dsm: the successful temporal error estimate. - :return: :c:type:`SUNErrCode` indicating success or failure + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: @@ -262,7 +262,7 @@ note these requirements below. Additionally, we note the behavior of the base SU :param leniw: (output) number of ``sunindextype`` words stored in the controller. This may also include pointers, `int` and `long int` words. - :return: :c:type:`SUNErrCode` indicating success or failure + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: diff --git a/doc/shared/sunadaptcontroller/SUNAdaptController_ImExGus.rst b/doc/shared/sunadaptcontroller/SUNAdaptController_ImExGus.rst index b4e7d66469..2963bd4667 100644 --- a/doc/shared/sunadaptcontroller/SUNAdaptController_ImExGus.rst +++ b/doc/shared/sunadaptcontroller/SUNAdaptController_ImExGus.rst @@ -119,7 +119,7 @@ routines: :param k2e: parameter used within the controller time step estimate. :param k1i: parameter used within the controller time step estimate. :param k2i: parameter used within the controller time step estimate. - :return: :c:type:`SUNErrCode` indicating success or failure + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: diff --git a/doc/shared/sunadaptcontroller/SUNAdaptController_Soderlind.rst b/doc/shared/sunadaptcontroller/SUNAdaptController_Soderlind.rst index 224360cf05..56243ec4af 100644 --- a/doc/shared/sunadaptcontroller/SUNAdaptController_Soderlind.rst +++ b/doc/shared/sunadaptcontroller/SUNAdaptController_Soderlind.rst @@ -111,7 +111,7 @@ also provides the following additional user-callable routines: :param k3: parameter used within the controller time step estimate. :param k4: parameter used within the controller time step estimate. :param k5: parameter used within the controller time step estimate. - :return: :c:type:`SUNErrCode` indicating success of failure. + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: @@ -147,7 +147,7 @@ also provides the following additional user-callable routines: :param k1: parameter used within the controller time step estimate. :param k2: parameter used within the controller time step estimate. :param k3: parameter used within the controller time step estimate. - :return: :c:type:`SUNErrCode` indicating success of failure. + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: @@ -181,7 +181,7 @@ also provides the following additional user-callable routines: :param C: the SUNAdaptController_Soderlind object. :param k1: parameter used within the controller time step estimate. :param k2: parameter used within the controller time step estimate. - :return: :c:type:`SUNErrCode` indicating success of failure. + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: @@ -214,7 +214,7 @@ also provides the following additional user-callable routines: :param C: the SUNAdaptController_Soderlind object. :param k1: parameter used within the controller time step estimate. - :return: :c:type:`SUNErrCode` indicating success of failure. + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: @@ -260,7 +260,7 @@ also provides the following additional user-callable routines: :param C: the SUNAdaptController_Soderlind object. :param k1_hat: parameter used within the explicit Gustafsson controller time step estimate. :param k2_hat: parameter used within the explicit Gustafsson controller time step estimate. - :return: :c:type:`SUNErrCode` indicating success of failure. + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: @@ -306,7 +306,7 @@ also provides the following additional user-callable routines: :param C: the SUNAdaptController_Soderlind object. :param k1_hat: parameter used within the implicit Gustafsson controller time step estimate. :param k2_hat: parameter used within the implicit Gustafsson controller time step estimate. - :return: :c:type:`SUNErrCode` indicating success of failure. + :return: :c:type:`SUNErrCode` indicating success or failure. Usage: diff --git a/doc/shared/sunmemory/SUNMemory_CUDA.rst b/doc/shared/sunmemory/SUNMemory_CUDA.rst index 70f72a27cf..be14ff97e9 100644 --- a/doc/shared/sunmemory/SUNMemory_CUDA.rst +++ b/doc/shared/sunmemory/SUNMemory_CUDA.rst @@ -68,7 +68,7 @@ The implementation provides the following operations defined by the **Returns:** - * A :c:type:`SUNErrCode` indicating success or failure + * A :c:type:`SUNErrCode` indicating success or failure. .. c:function:: SUNErrCode SUNMemoryHelper_Dealloc_Cuda(SUNMemoryHelper helper, \ @@ -85,7 +85,7 @@ The implementation provides the following operations defined by the **Returns:** - * A :c:type:`SUNErrCode` indicating success or failure + * A :c:type:`SUNErrCode` indicating success or failure. .. c:function:: SUNErrCode SUNMemoryHelper_Copy_Cuda(SUNMemoryHelper helper, \ @@ -108,7 +108,7 @@ The implementation provides the following operations defined by the **Returns:** - * A :c:type:`SUNErrCode` indicating success or failure + * A :c:type:`SUNErrCode` indicating success or failure. .. c:function:: SUNErrCode SUNMemoryHelper_CopyAsync_Cuda(SUNMemoryHelper helper, \ @@ -133,7 +133,7 @@ The implementation provides the following operations defined by the **Returns:** - * A :c:type:`SUNErrCode` indicating success or failure + * A :c:type:`SUNErrCode` indicating success or failure. .. c:function:: SUNErrCode SUNMemoryHelper_GetAllocStats_Cuda(SUNMemoryHelper helper, SUNMemoryType mem_type, unsigned long* num_allocations, \ @@ -153,4 +153,4 @@ The implementation provides the following operations defined by the **Returns:** - * A :c:type:`SUNErrCode` indicating success or failure + * A :c:type:`SUNErrCode` indicating success or failure.