Fix a few function names in USAGE comments that don't match the actual #4533
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lrknox
requested review from
derobins,
byrnHDF,
fortnern,
jhendersonHDF,
qkoziol,
vchoi-hdfgroup,
bmribler,
glennsong09,
mattjala and
brtnfld
as code owners
lrknox
commented
May 29, 2024
| @@ -413,7 +413,7 @@ H5S_get_select_npoints(const H5S_t *space) | |||
| Check whether the selection fits within the extent, with the current | |||
| offset defined. | |||
| USAGE | |||
| htri_t H5Sselect_void(dsid) | |||
| htri_t H5Sselect_valid(dsid) | |||
| hid_t dsid; IN: Dataspace ID to query | |||
There was a problem hiding this comment.
I assume dsid here and spaceid in line 430 are the same. Would it be better if they match?
lrknox
commented
May 29, 2024
| const H5F_t *f; IN: File opened object is in | ||
| haddr_t addr; IN: Address of object to delete | ||
| bool deleted; IN: true for to be deleted |
There was a problem hiding this comment.
Should this be added, or is it too obvious?
byrnHDF
approved these changes
May 30, 2024
lrknox
added
Merge - To 1.14
derobins
approved these changes
Jun 2, 2024
lrknox
added a commit
to lrknox/hdf5
that referenced
this pull request
Jun 7, 2024
HDFGroup#4533) * Fix a few function names in USAGE comments that don't match the actual function names. * Remove typo '[' * Switch to working url for api-compatibility-macros.html.
derobins
added a commit
that referenced
this pull request
Jun 8, 2024
* Fix daily-build CI and correct use of *_FOUND settings for filters (#4504) * Correct examples tests to just run under dynamic analysis (#4505) * Remove trailing extra whitespace in hyperlink (#4509) * Set H5 specific vars immediately if legacy find (#4512) * Set H5 specific vars immediately if legacy find * Correct find process vars (vs in-line build) * Correct SZIP find * Everything is libaec 1.0.6 or newer * Correct option help text * Don't update 'pos' and 'op' fields when using pread/pwrite (#4492) Instead of reading the absolute minimal possible, use the likely value of a v2+ superblock w/8-byte addresses & lengths. * Fix spelling (#4522) * Fix typo in DAPL callback documentation (#4523) * Move/rename libhdf5.settings input files (#4525) Move without other changes: src/libhdf5.settings.in -> src/libhdf5.settings.autotools.in config/cmake/libhdf5.settings.cmake.in -> src/libhdf5.settings.cmake.in * Disable UNITY_BUILD for now - globally (#4515) * Fix function name in USAGE for H5Pencode2() (#4519) * Allow HDF5_LIB_INFIX to work with DLL (#4500) * Allow HDF5_LIB_INFIX to work with DLL * Separate individual library name into parts and add suffix option * Java cannot use alternative names and removed extra setting * Incorporate the underscore into the CORE name * Fix typos in property callback documentation (#4532) * Fix wrong int type as some systems have int as 64-bit wide (#4534) * H5FDquery return value (#4530) * Switch H5FDquery() return values to use library's FAIL / SUCCEED macros * Update return value also * Refactor to reduce code duplication (#4531) * Update error output w/new routine name * Fix a few function names in USAGE comments that don't match the actual (#4533) * Fix a few function names in USAGE comments that don't match the actual function names. * Remove typo '[' * Switch to working url for api-compatibility-macros.html. * Remove julia CI actions (#4540) These have been failing for a week or two for unclear reasons, both in the Autotools and CMake. No obvious library changes triggered this. See GitHub issue #4539 for more info/discussion The Julia tests will be disabled until the root cause is found. * Bump the github-actions group with 3 updates (#4538) Bumps the github-actions group with 3 updates: [softprops/action-gh-release](https://github.com/softprops/action-gh-release), [ossf/scorecard-action](https://github.com/ossf/scorecard-action) and [github/codeql-action](https://github.com/github/codeql-action). Updates `softprops/action-gh-release` from 2.0.4 to 2.0.5 - [Release notes](https://github.com/softprops/action-gh-release/releases) - [Changelog](https://github.com/softprops/action-gh-release/blob/master/CHANGELOG.md) - [Commits](softprops/action-gh-release@9d7c94c...69320db) Updates `ossf/scorecard-action` from 2.3.1 to 2.3.3 - [Release notes](https://github.com/ossf/scorecard-action/releases) - [Changelog](https://github.com/ossf/scorecard-action/blob/main/RELEASE.md) - [Commits](ossf/scorecard-action@0864cf1...dc50aa9) Updates `github/codeql-action` from 3.25.3 to 3.25.7 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@d39d31e...f079b84) --- updated-dependencies: - dependency-name: softprops/action-gh-release dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions - dependency-name: ossf/scorecard-action dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions - dependency-name: github/codeql-action dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Fix various mistakes in doxygen docs (#4541) * Fix a dead link and example file names * Add the missing content of a section * Export HDF5 parallel status for CMake FetchContent'ed VOL connectors (#4542) * Remove an unnecessary check for parallel and thread-safety from examples (#4543) * Add option to use zlib-ng as zlib library (#4487) * Export HDF5 version for CMake FetchContent'ed VOL connectors (#4548) * Adjust h5repack userblock option to allow reserve size (#4544) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Co-authored-by: H. Joe Lee <hyoklee@hdfgroup.org> Co-authored-by: Quincey Koziol <quincey@koziol.cc> Co-authored-by: jhendersonHDF <jhenderson@hdfgroup.org> Co-authored-by: mattjala <124107509+mattjala@users.noreply.github.com> Co-authored-by: Dana Robinson <43805+derobins@users.noreply.github.com> Co-authored-by: Peter Chang <peter.chang@diamond.ac.uk> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: bmribler <39579120+bmribler@users.noreply.github.com> Co-authored-by: Scot Breitenfeld <brtnfld@hdfgroup.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
function names.
Sometimes parameters and parameter documentation are missing.
Often copy/paste operations with incomplete modification.
I think it is likely there are more, and I'll add a couple of specific questions in the code. I came across these while reviewing another PR, and thought I would create this one to see if these are something we want to fix.