Skip to content

Commit bdfc919

Browse files
committed
docs: update descr for remove error class/code/string
Signed-off-by: Thomas Naughton <[email protected]>
1 parent 964f869 commit bdfc919

File tree

3 files changed

+20
-11
lines changed

3 files changed

+20
-11
lines changed

docs/man-openmpi/man3/MPI_Remove_error_class.3.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ MPI_Remove_error_class
66

77
.. include_body
88
9-
:ref:`MPI_Remove_error_class` |mdash| Removes an error class.
9+
:ref:`MPI_Remove_error_class` |mdash| Removes a user-created error class.
1010

1111
.. The following file was automatically generated
1212
.. include:: ./bindings/mpi_remove_error_class.rst
@@ -22,14 +22,19 @@ OUTPUT PARAMETERS
2222
DESCRIPTION
2323
-----------
2424

25-
The function :ref:`MPI_Remove_error_class` removes a local error class.
25+
The function :ref:`MPI_Remove_error_class` removes a user-created error class.
26+
It is erroneous to call :ref:`MPI_Remove_error_class` with a value for
27+
*errorclass* that was not added by a call to :ref:`MPI_Add_error_class`.
28+
It is erroneous to remove an error class when its associated error codes
29+
have not been removed before.
2630

2731
ERRORS
2832
------
2933

3034
.. include:: ./ERRORS.rst
3135

3236
.. seealso::
37+
* :ref:`MPI_Add_error_class`
3338
* :ref:`MPI_Remove_error_code`
3439
* :ref:`MPI_Remove_error_string`
3540
* :ref:`MPI_Error_class`

docs/man-openmpi/man3/MPI_Remove_error_code.3.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ MPI_Remove_error_code
66

77
.. include_body
88
9-
:ref:`MPI_Remove_error_code` |mdash| Remove an error code associated with
9+
:ref:`MPI_Remove_error_code` |mdash| Remove a user-created error code associated with
1010
*errorcode*
1111

1212
.. The following file was automatically generated
@@ -23,14 +23,19 @@ OUTPUT PARAMETERS
2323
DESCRIPTION
2424
-----------
2525

26-
Removes an error code associated with *errorcode*.
27-
26+
Removes a user-created error code associated with *errorcode*.
27+
It is erroneous to call :ref:`MPI_Remove_error_code` with a value for
28+
*errorcode* that was not added by a call to :ref:`MPI_Add_error_code`.
29+
It is erroneous to remove an error code when its associated error string has
30+
not been removed before.
2831

2932
ERRORS
3033
------
3134

3235
.. include:: ./ERRORS.rst
3336

3437
.. seealso::
38+
* :ref:`MPI_Add_error_code`
3539
* :ref:`MPI_Remove_error_class`
40+
* :ref:`MPI_Remove_error_string`
3641
* :ref:`MPI_Error_class`

docs/man-openmpi/man3/MPI_Remove_error_string.3.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ MPI_Remove_error_string
77
.. include_body
88
99
:ref:`MPI_Remove_error_string` |mdash| Removes the error string associated with
10-
an error code.
10+
a user-created error code.
1111

1212
.. The following file was automatically generated
1313
.. include:: ./bindings/mpi_remove_error_string.rst
@@ -23,18 +23,17 @@ OUTPUT PARAMETER
2323
DESCRIPTION
2424
-----------
2525

26-
This routine removes an error string associated with an error code.
27-
It is erroneous to call :ref:`MPI_Remove_error_string` for an error value not
28-
generated via :ref:`MPI_Remove_error_code` (e.g., an error
29-
code with a value not greater than MPI_LAST_ERRCODE).
30-
26+
This routine removes an error string associated with a user-created error code.
27+
It is erroneous to call :ref:`MPI_Remove_error_string` with a value for *errorcode*
28+
that does not have an error string added by a call to :ref:`MPI_Add_error_string`.
3129

3230
ERRORS
3331
------
3432

3533
.. include:: ./ERRORS.rst
3634

3735
.. seealso::
36+
* :ref:`MPI_Add_error_string`
3837
* :ref:`MPI_Remove_error_class`
3938
* :ref:`MPI_Remove_error_code`
4039
* :ref:`MPI_Error_class`

0 commit comments

Comments
 (0)