Skip to content

Commit

Permalink
Docs: Add missing SUNContext argument to *NewEmpty docs (#471)
Browse files Browse the repository at this point in the history
  • Loading branch information
Steven-Roberts authored May 7, 2024
1 parent 31ffc21 commit bd0a86f
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc/shared/nvectors/NVector_Description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ routines these functions will ease the introduction of any new optional vector
operations to the NVECTOR API by ensuring that only required operations need
to be set, and that all operations are copied when cloning a vector.
.. c:function:: N_Vector N_VNewEmpty()
.. c:function:: N_Vector N_VNewEmpty(SUNContext sunctx)
This allocates a new generic ``N_Vector`` object and initializes its content
pointer and the function pointers in the operations structure to ``NULL``.
Expand Down
2 changes: 1 addition & 1 deletion doc/shared/sunlinsol/SUNLinSol_API.rst
Original file line number Diff line number Diff line change
Expand Up @@ -765,7 +765,7 @@ constructors this function will ease the introduction of any new optional linear
solver operations to the ``SUNLinearSolver`` API by ensuring that only required
operations need to be set.

.. c:function:: SUNLinearSolver SUNLinSolNewEmpty()
.. c:function:: SUNLinearSolver SUNLinSolNewEmpty(SUNContext sunctx)
This function allocates a new generic ``SUNLinearSolver`` object and
initializes its content pointer and the function pointers in the operations
Expand Down
2 changes: 1 addition & 1 deletion doc/shared/sunmatrix/SUNMatrix_Description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ routines these functions will ease the introduction of any new optional matrix
operations to the SUNMATRIX API by ensuring only required operations need to be
set and all operations are copied when cloning a matrix.

.. c:function:: SUNMatrix SUNMatNewEmpty()
.. c:function:: SUNMatrix SUNMatNewEmpty(SUNContext sunctx)
This function allocates a new generic ``SUNMatrix`` object and initializes its
content pointer and the function pointers in the operations structure to ``NULL``.
Expand Down
2 changes: 1 addition & 1 deletion doc/shared/sunnonlinsol/SUNNonlinSol_API.rst
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,7 @@ introduction of any new optional nonlinear solver operations to the
``SUNNonlinearSolver`` API by ensuring that only required operations need to
be set.
.. c:function:: SUNNonlinearSolver SUNNonlinSolNewEmpty()
.. c:function:: SUNNonlinearSolver SUNNonlinSolNewEmpty(SUNContext sunctx)
This function allocates a new generic ``SUNNonlinearSolver`` object and
initializes its content pointer and the function pointers in the operations
Expand Down

0 comments on commit bd0a86f

Please sign in to comment.