docs: fix 6 typos in documentation comments - #13
Open
Avicennasis wants to merge 1 commit into
Open
Avicennasis wants to merge 1 commit into
Avicennasis wants to merge 1 commit into
Conversation
Comment-only spelling corrections in PHManager.swift and PHCache.swift. No identifiers, code, or behaviour are changed. Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
This file contains hidden or 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
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.
Summary
Fixes 6 spelling typos in documentation comments in
PHManager.swiftandPHCache.swift. No identifiers, code, or behaviour are changed - every hunkis inside a
///or/** */doc comment.cancel ongoing reques->cancel ongoing requests;Convinience method->Convenience method(x2);Purche memory and file cache->
Purge memory and file cacheClear expired and overexeeded max size file cache->
Clear expired and exceeded max size file cache;while file chache is 50%->while file cache is 50%Deliberately left alone
Several other misspellings in this library are part of the public API surface
and cannot be corrected without a breaking change, so they are untouched:
comletion:- the external parameter label ofPHManager.imageData(_:comletion:).The
- parameter comletion:doc tag correctly matches it.clearFileChache(_:)onPHCache, called from two places inPHManager.contentLenght:- the parameter label ofPHDownload.progress(_:contentLenght:).arkColor- a property ofPHProgressView.The double space in
DispatchQueue(label: imageKitDomain + ".ioQueue")(
PHFileCache.swift) is formatting rather than a typo and is also left as is.