Skip to content

Commit

Permalink
A couple of documentation items to fix (#3332)
Browse files Browse the repository at this point in the history
  • Loading branch information
byrnHDF authored Aug 2, 2023
1 parent 7ed8dd7 commit 8e9c281
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
1 change: 0 additions & 1 deletion .clang-format
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ StatementMacros:
- H5_GCC_DIAG_ON
- H5_LEAVE
- HGOTO_DONE
- HGOTO_ERROR
- HMPI_DONE_ERROR
- HMPI_ERROR
- HMPI_GOTO_ERROR
Expand Down
8 changes: 4 additions & 4 deletions doc/getting-started-with-hdf5-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ H5X_do_stuff(/*parameters*/)
HDassert(/*parameter check*/);

if (H5X_other_call() < 0)
HGOTO_ERROR(H5E_MAJ, H5E_MIN, FAIL, "badness")
HGOTO_ERROR(H5E_MAJ, H5E_MIN, FAIL, "badness");

done:
if (ret_value < 0)
Expand Down Expand Up @@ -329,12 +329,12 @@ H5Xdo_api_stuff(/*parameters*/)
H5TRACE3(/*stuff*/)
if (/*parameter check*/)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "badness")
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "badness");
/* VOL setup */
if (H5VL_call() < 0)
HGOTO_ERROR(H5E_FOO, H5E_BAR, FAIL, "badness")
HGOTO_ERROR(H5E_FOO, H5E_BAR, FAIL, "badness");
done:
if (ret_value < 0)
Expand Down Expand Up @@ -483,7 +483,7 @@ fail. The general format is this:

```c
if (function_that_could_fail(foo, bar) < 0)
HGOTO_ERROR(H5E_<major>, H5E_<minor>, <bad value>, "tell me about badness")
HGOTO_ERROR(H5E_<major>, H5E_<minor>, <bad value>, "tell me about badness");
```
`HGOTO_ERROR` is one of a set of macros defined in `H5Eprivate.h`. This macro
Expand Down

0 comments on commit 8e9c281

Please sign in to comment.