Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed Spelling Errors #1166

Merged
merged 77 commits into from
Dec 7, 2021
Merged

Fixed Spelling Errors #1166

merged 77 commits into from
Dec 7, 2021

Conversation

brtnfld
Copy link
Contributor

@brtnfld brtnfld commented Nov 5, 2021

Fixed all spelling errors caught with codespell, added new spell checker to github actions to detect spelling errors.

brtnfld and others added 30 commits February 3, 2021 11:19
test/dt_arith.c Outdated
@@ -3326,7 +3326,7 @@ test_conv_flt_1(const char *name, int run_test, hid_t src, hid_t dst)
HDputs(" maximum failures reached, aborting test...");
else if (run_test == TEST_DENORM || run_test == TEST_SPECIAL)
HDputs(" maximum warnings reached, aborting test...");
HDputs(" (dst is library's conversion output. ans is compiler's conversion output.)");
HDputs(" (dst is library's conversion output. and is compiler's conversion output.)");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

still needs fixed

Copy link
Contributor

@byrnHDF byrnHDF left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still some fixes needed

@brtnfld
Copy link
Contributor Author

brtnfld commented Nov 11, 2021

Still some fixes needed

Can you be more specific?

@byrnHDF
Copy link
Contributor

byrnHDF commented Nov 11, 2021

Still some fixes needed

Can you be more specific?

test/dt_arith.c - did all the "ans" to "and" issues get fixed?
tools/src/h5import/h5import.h - did the define "FILENAM" get fixed.

Sorry, but I can't seem to discover that in the changes view.

@brtnfld
Copy link
Contributor Author

brtnfld commented Nov 11, 2021

Still some fixes needed

Can you be more specific?

test/dt_arith.c - did all the "ans" to "and" issues get fixed?

yes

tools/src/h5import/h5import.h - did the define "FILENAM" get fixed.

I reverted the change, it is still FILNAME.

Sorry, but I can't seem to discover that in the changes view.

@brtnfld
Copy link
Contributor Author

brtnfld commented Nov 23, 2021

@lrknox What is remaining for this PR? I would rather not have to keep syncing this branch.

Copy link
Contributor

@byrnHDF byrnHDF left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I finally got the correct view of the files - looks better

@@ -1484,7 +1484,7 @@ H5C_insert_entry(H5F_t *f, const H5C_class_t *type, haddr_t addr, void *thing, u
* Finally, we usually don't check to see if the cache is
* oversized at the end of an unprotect. As a result, it is
* possible to have a vastly oversized cache with no protected
* entries as long as all the protects preceed the unprotects.
* entries as long as all the protects proceed the unprotects.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be precede

@@ -2444,7 +2444,7 @@ H5C_protect(H5F_t *f, const H5C_class_t *type, haddr_t addr, void *udata, unsign
* Finally, we usually don't check to see if the cache is
* oversized at the end of an unprotect. As a result, it is
* possible to have a vastly oversized cache with no protected
* entries as long as all the protects preceed the unprotects.
* entries as long as all the protects proceed the unprotects.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

precede

src/H5Cprivate.h Outdated Show resolved Hide resolved
src/H5Cprivate.h Outdated Show resolved Hide resolved
@@ -777,7 +777,7 @@ SUBROUTINE test_attr_info_by_idx(new_format, fcpl, fapl, total_error)
INTEGER :: Input1
INTEGER(HSIZE_T) :: hzero = 0_HSIZE_T
INTEGER :: minusone = -1
INTEGER(HSIZE_T) :: htmp
INTEGER(HSIZE_T) :: html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a typo. htmp is "temporary h", not HTML. Maybe rename it h_temp?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or htemp

- uses: codespell-project/actions-codespell@master
with:
skip: ./bin/trace,./hl/tools/h5watch/h5watch.c,./tools/test/h5jam/tellub.c
ignore_words_list: isnt,inout,nd,parms,parm,ba,offsetP,ser,ois,had,fiter,fo,clude,refere,minnum,offsetp,creat,ans:,eiter,lastr,minum,ans,isn't,ifset,sur,trun,dne,tthe,hda,filname,te,htmp
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a fan of running this automatically. There were several instances of the spell checker making mistakes in this PR, some of which were in actual code and not comments.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I disagree, the false positives are relatively low. It should be checked as part of the PR, if it becomes a major issue then we can revisit it.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW the action doesn't do anything (like fix things) by default aside from fail if it finds typos. I run it on a number of repos and it doesn't often flag new false positives and when it does it's easy enough to add them to the ignore or skip lists as appropriate.

@lrknox lrknox merged commit f859cb7 into HDFGroup:develop Dec 7, 2021
mkitti added a commit to mkitti/hdf5 that referenced this pull request Aug 5, 2022
derobins added a commit that referenced this pull request Aug 16, 2022
* Revert "Revert H5Dchunk_iter changes in hdf5_1_12_1 (#733)"

This reverts commit 10abe9a.

* Apply clang-format

* Reincorporate spelling fix from #1166

* Incorporate H5Dchunk_iter changes from #161

* Backport to 1.12: Adds a quick for for some egregious chunk_info badness (#722)

* Backport to 1.12: Converts testhdf5 macros to h5test macros in chunk_info.c (#1820)

The two macro schemes were not designed to work together. Also
quiets some MSVC warnings about comparing pointers and integers.

* Backport to 1.12: H5Dchunk_iter now passes offsets in units of dataset elements, fix #1419 (#1969)

* H5Dchunk_iter now passes chunk dimension scaled offsets, fix #1419

* Update docs for H5Dchunk_iter, H5Dget_chunk_info*

Modified description for `H5Dchunk_iter`, `H5Dget_chunk_info`, and `H5Dget_chunk_info_by_coord` to the following

 * offset          Logical position of the chunk’s first element in units of dataset elements
 * filter_mask  Bitmask indicating the filters used when the chunk was written
 * size             Chunk size in bytes, 0 if the chunk does not exist

* Sync H5Dchunk_iter documentation with develop

* Remove H5VL_DATASET_WAIT references from 1.12

* Backport to 1.12 #161, #1474, review comments

Co-authored-by: Dana Robinson <43805+derobins@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants