directory_iterator: improve documentation #135
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
This change rewrites documentation for the sqsh_file_iterator_skip(). It explains the behavior of the function itself better and focuses on the `offset` parameter as this seems to be a confusing part.
|
Kudos, SonarCloud Quality Gate passed!
|
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #135 +/- ##
=======================================
Coverage 60.28% 60.28%
=======================================
Files 58 58
Lines 4769 4769
Branches 718 718
=======================================
Hits 2875 2875
Misses 1480 1480
Partials 414 414 ☔ View full report in Codecov by Sentry. |
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.
This change rewrites documentation for the sqsh_file_iterator_skip(). It explains the behavior of the function itself better and focuses on the
offsetparameter as this seems to be a confusing part.