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

Spelling #2067

Merged
merged 91 commits into from
Feb 4, 2022
Merged

Spelling #2067

merged 91 commits into from
Feb 4, 2022

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Feb 3, 2022

This PR corrects misspellings identified by the check-spelling action.

The misspellings have been reported at jsoref@70a7c49#commitcomment-65911822

The action reports that the changes in this PR would make it happy: jsoref@37f930d

Note: this PR does not include the action. If you're interested in running a spell check on every PR and push, that can be offered separately.

I intend to annotate this PR shortly. I'm happy to drop changes to files, drop specific terms, or split things as requested, although this may take some time.

sridharb1
sridharb1 previously approved these changes Feb 3, 2022
Copy link
Collaborator

@sridharb1 sridharb1 left a comment

Choose a reason for hiding this comment

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

Thank you, looks good

Copy link
Contributor Author

@jsoref jsoref left a comment

Choose a reason for hiding this comment

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

The vast majority of the corrections were automatically suggested by Google Sheets (especially any preference for en-US over en-GB).

But all fault is mine.

exiv2json has a recursive parser to encode XMP into Vectors and Objects. XMP data is XMP and can contain XMP `Bag` and `Seq` which are converted to JSON Objects and Arrays. Exiv2 presents data in the format: [Family.Group.Tagname](exiv2.md#exiv2_key_syntax). For XMP, results in "flat" output such such as:
exiv2json has a recursive parser to encode XMP into Vectors and Objects. XMP data is XMP and can contain XMP `Bag` and `Seq` which are converted to JSON Objects and Arrays. Exiv2 presents data in the format: [Family.Group.Tagname](exiv2.md#exiv2_key_syntax). For XMP, results in "flat" output such as:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Normally my PRs only look at individual words, but I've been toying with this related task of identifying duplicated words. This repository was good input for my tool.

If feedback on this feature is negative, I may drop it going forward.

For simplicity, I've tagged these commits with the word that was duplicated, although, I might change my commit messages based on feedback.

Usage: remotetest remotetest file {--nocurl | --curl}
Usage: remotetest file {--nocurl | --curl}
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 didn't see any indication for this duplication...

| [![Basic CI for all platforms on push](https://github.com/Exiv2/exiv2/actions/workflows/on_push_BasicWinLinMac.yml/badge.svg?branch=main)](https://github.com/Exiv2/exiv2/actions/workflows/on_push_BasicWinLinMac.yml) | [![CI for different Linux distributions](https://github.com/Exiv2/exiv2/actions/workflows/nightly_Linux_distributions.yml/badge.svg?branch=main)](https://github.com/Exiv2/exiv2/actions/workflows/nightly_Linux_distributions.yml) | [![Linux Special Builds on PRs](https://github.com/Exiv2/exiv2/actions/workflows/on_PR_linux_special_buils.yml/badge.svg)](https://github.com/Exiv2/exiv2/actions/workflows/on_PR_linux_special_buils.yml) |
| [![Basic CI for all platforms on push](https://github.com/Exiv2/exiv2/actions/workflows/on_push_BasicWinLinMac.yml/badge.svg?branch=main)](https://github.com/Exiv2/exiv2/actions/workflows/on_push_BasicWinLinMac.yml) | [![CI for different Linux distributions](https://github.com/Exiv2/exiv2/actions/workflows/nightly_Linux_distributions.yml/badge.svg?branch=main)](https://github.com/Exiv2/exiv2/actions/workflows/nightly_Linux_distributions.yml) | [![Linux Special Builds on PRs](https://github.com/Exiv2/exiv2/actions/workflows/on_PR_linux_special_builds.yml/badge.svg)](https://github.com/Exiv2/exiv2/actions/workflows/on_PR_linux_special_builds.yml) |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file is renamed above.

Copy link
Collaborator

Choose a reason for hiding this comment

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

This is fine, but note this will lead to a completely new workflow created here (with the same name though), and the old runs will have to be deleted via the API.

# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
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'm happy to drop files/exclude paths, just let me know what should be skipped.

JavaScript is a brand... (catching this actually relied on the same extra tooling as catching duplicate words)

Comment on lines 1 to +2
# This module provides function for joining paths
# known from from most languages
# known from most languages
Copy link
Contributor Author

Choose a reason for hiding this comment

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

My changes are for spelling (duplicate words are often detected by classic spell checkers) and don't cover grammar. In this case, even w/ this fix, the text doesn't make much sense.

src/nikonmn_int.cpp Outdated Show resolved Hide resolved
// bage age
// baby age
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 had to look this one up...

xmpsdk/include/TXMPUtils.hpp Outdated Show resolved Hide resolved
xmpsdk/include/client-glue/TXMPMeta.incl_cpp Outdated Show resolved Hide resolved
xmpsdk/src/XMPUtils-FileInfo.cpp Outdated Show resolved Hide resolved
Copy link
Collaborator

@piponazo piponazo left a comment

Choose a reason for hiding this comment

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

Thanks a lot for the contribution! It is really appreciated.

I would also love to see (probably in a separated PR) the inclusion on the action in the project. Most of the collaborators are non native English-speakers, and it will probably find us to help typos eventually.

I made few comments here and there about things we could drop.

"References to resources that were incorporated, byinclusion or reference, "
"References to resources that were incorporated, by inclusion or reference, "
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it is fine, since you also fixed the typo in the properties.cpp file.

src/crwimage_int.cpp Outdated Show resolved Hide resolved
src/nikonmn_int.cpp Outdated Show resolved Hide resolved
xmpsdk/include/TXMPUtils.hpp Outdated Show resolved Hide resolved
@sridharb1
Copy link
Collaborator

sridharb1 commented Feb 3, 2022 via email

@clanmills
Copy link
Collaborator

clanmills commented Feb 3, 2022

@sridharb1 Thank You for saying "I would vote to drop all the changes done inside the xmpsdk folder. ". I agree and you've explained the reason.

@jsoref This is a really good contribution. I'm a native english speaker (Scottish) and I'm dyslexic (also Scottish!). So all the typos in README.md and elsewhere are mine. Thank You for working on this. I prefer en-US because it's more conventional for Open-Source. (I'm also a US Citizen).

When you've finished on this, I'd appreciate similar treatment being given to my book: https://github.com/Exiv2/team.exiv2.org

| [![Basic CI for all platforms on push](https://github.com/Exiv2/exiv2/actions/workflows/on_push_BasicWinLinMac.yml/badge.svg?branch=main)](https://github.com/Exiv2/exiv2/actions/workflows/on_push_BasicWinLinMac.yml) | [![CI for different Linux distributions](https://github.com/Exiv2/exiv2/actions/workflows/nightly_Linux_distributions.yml/badge.svg?branch=main)](https://github.com/Exiv2/exiv2/actions/workflows/nightly_Linux_distributions.yml) | [![Linux Special Builds on PRs](https://github.com/Exiv2/exiv2/actions/workflows/on_PR_linux_special_buils.yml/badge.svg)](https://github.com/Exiv2/exiv2/actions/workflows/on_PR_linux_special_buils.yml) |
| [![Basic CI for all platforms on push](https://github.com/Exiv2/exiv2/actions/workflows/on_push_BasicWinLinMac.yml/badge.svg?branch=main)](https://github.com/Exiv2/exiv2/actions/workflows/on_push_BasicWinLinMac.yml) | [![CI for different Linux distributions](https://github.com/Exiv2/exiv2/actions/workflows/nightly_Linux_distributions.yml/badge.svg?branch=main)](https://github.com/Exiv2/exiv2/actions/workflows/nightly_Linux_distributions.yml) | [![Linux Special Builds on PRs](https://github.com/Exiv2/exiv2/actions/workflows/on_PR_linux_special_builds.yml/badge.svg)](https://github.com/Exiv2/exiv2/actions/workflows/on_PR_linux_special_builds.yml) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is fine, but note this will lead to a completely new workflow created here (with the same name though), and the old runs will have to be deleted via the API.

include/exiv2/datasets.hpp Outdated Show resolved Hide resolved
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
@codecov
Copy link

codecov bot commented Feb 4, 2022

Codecov Report

Merging #2067 (709082e) into main (55712d4) will decrease coverage by 55.76%.
The diff coverage is 0.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #2067       +/-   ##
==========================================
- Coverage   61.48%   5.72%   -55.77%     
==========================================
  Files          96      96               
  Lines       19207   18955      -252     
  Branches     9843    9843               
==========================================
- Hits        11810    1085    -10725     
- Misses       5080   17682    +12602     
+ Partials     2317     188     -2129     
Impacted Files Coverage Δ
include/exiv2/basicio.hpp 75.00% <ø> (-25.00%) ⬇️
include/exiv2/datasets.hpp 0.00% <ø> (-100.00%) ⬇️
include/exiv2/slice.hpp 90.67% <ø> (-0.85%) ⬇️
include/exiv2/tags.hpp 0.00% <ø> (-100.00%) ⬇️
include/exiv2/types.hpp 44.11% <ø> (-26.48%) ⬇️
include/exiv2/value.hpp 2.80% <ø> (-80.71%) ⬇️
src/actions.hpp 0.00% <ø> (-100.00%) ⬇️
src/basicio.cpp 16.25% <0.00%> (-33.51%) ⬇️
src/bmffimage.cpp 0.00% <ø> (-76.07%) ⬇️
src/canonmn_int.cpp 0.00% <ø> (-64.52%) ⬇️
... and 109 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 55712d4...709082e. Read the comment docs.

@piponazo piponazo merged commit e56abfa into Exiv2:main Feb 4, 2022
@jsoref jsoref deleted the spelling branch February 4, 2022 12:58
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