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

Improve easyaccess documentation #2706

Merged
merged 4 commits into from Jul 21, 2023

Conversation

norbertwg
Copy link
Contributor

Refers to issue #2204 : Some explanations added to easyaccess API.

@ghost
Copy link

ghost commented Jul 19, 2023

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

@neheb neheb requested a review from kmilos July 20, 2023 00:03
Comment on lines 33 to 35
//! Return the ISO speed used to shoot the image. Please keep in mind that this accessor is provided for convenience
//! only and will return expected/desired metadata most of the time.
EXIV2API ExifData::const_iterator isoSpeed(const ExifData& ed);
Copy link
Collaborator

Choose a reason for hiding this comment

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

As there is some extra computation involved for ISO, maybe another sentence (similar to lens detection) is warranted?

@norbertwg
Copy link
Contributor Author

@kmilos : I was not aware of this, thanks for the hint. Is following addition fine?

Please note also that ISO speed function uses some computations, which might involve combining information from multiple tags and interpreting numeric codes. While the computations try to cover most cases, they can't be perfect and might fail in some circumstances, leading to imprecise results.

@kmilos
Copy link
Collaborator

kmilos commented Jul 20, 2023

Is following addition fine?

Great, thanks @norbertwg

@codecov
Copy link

codecov bot commented Jul 20, 2023

Codecov Report

Merging #2706 (7d1c31b) into main (a2d6996) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2706   +/-   ##
=======================================
  Coverage   63.91%   63.91%           
=======================================
  Files         103      103           
  Lines       22313    22313           
  Branches    10804    10804           
=======================================
  Hits        14261    14261           
  Misses       5828     5828           
  Partials     2224     2224           

Copy link
Collaborator

@kmilos kmilos left a comment

Choose a reason for hiding this comment

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

LGTM

@kmilos kmilos merged commit 3e8e09d into Exiv2:main Jul 21, 2023
97 of 105 checks passed
@kmilos
Copy link
Collaborator

kmilos commented Jul 21, 2023

@Mergifyio backport 0.28.x

@mergify
Copy link
Contributor

mergify bot commented Jul 21, 2023

backport 0.28.x

✅ Backports have been created

@norbertwg norbertwg deleted the improve-easyaccess-documentation branch July 21, 2023 17:39
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.

None yet

2 participants