Tidying up registered filter document #166
Merged
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
Contributor
ajelenak
commented
Feb 18, 2025
ajelenak
commented
- Use Markdown more, less explicit HTML.
- Remove "Filter" from most of the section titles since it is obvious what are those sections about.
- Improve formatting and consistency of the text.
ajelenak
requested review from
lrknox,
byrnHDF,
derobins,
fortnern,
jhendersonHDF,
bmribler,
glennsong09,
mattjala and
brtnfld
as code owners
byrnHDF
approved these changes
Feb 18, 2025
lrknox
reviewed
Feb 18, 2025
lrknox
reviewed
Feb 18, 2025
docs/RegisteredFilterPlugins.md
Outdated
| @@ -229,282 +230,279 @@ LZ4 Code: | |||
| Although the LZ4 software is not supported by The HDF Group, it is included in The HDF Group SVN repository so that it can be tested regularly with HDF5. For convenience, users can obtain it from SVN with the following command: | |||
| svn checkout https://svn.hdfgroup.org/hdf5_plugins/trunk/LZ4 LZ4 | |||
There was a problem hiding this comment.
There was a problem hiding this comment.
I used this link https://github.com/HDFGroup/hdf5_plugins/tree/master/LZ4. Because it goes with the rest of the text. Should the entire text be removed, and just the link @byrnHDF suggested bu used? We do seem to have the LZ4 source code in this repo.
There was a problem hiding this comment.
From the lz4.c file in LZ4/src/lib:
You can contact the author at :
- LZ4 homepage : http://www.lz4.org
- LZ4 source repository : https://github.com/lz4/lz4
There was a problem hiding this comment.
Sorry - I thought that was a link to LZ4 - but you want the link to LZ4 in the hdf5_plugins repo.
There was a problem hiding this comment.
Yes, I used that one.
Tidy up various grammar and spelling issues.
brtnfld
reviewed
Feb 18, 2025
bmribler
approved these changes
Feb 18, 2025
ajelenak
commented
Feb 18, 2025
brtnfld
approved these changes
Feb 18, 2025
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.