docs: clarify ResourceFetcher class docstring#1087
Open
msluszniak wants to merge 1 commit intomainfrom
Open
Conversation
The file-level and class-level docstrings listed pauseFetching, resumeFetching, cancelFetching, getFilesTotalSize, listDownloadedFiles, listDownloadedModels, and deleteResources as available on ResourceFetcher. Those methods only exist on the concrete adapter implementations (ExpoResourceFetcher, BareResourceFetcher). Rewrite both docstrings to describe ResourceFetcher as the static entry point that delegates to a configured adapter, and direct readers to the adapter packages when they want the storage-management utilities. Refs #1086 (item 4). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.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
1 participant
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
Both the file-level docstring and the
ResourceFetcherclass docstring listedpauseFetching,resumeFetching,cancelFetching,getFilesTotalSize,listDownloadedFiles,listDownloadedModels, anddeleteResourcesas if they were available on the class. They aren't — those methods only exist on the concrete adapter implementations (ExpoResourceFetcher,BareResourceFetcher).This PR rewrites both docstrings to:
ResourceFetcheras a static-only entry point that delegates to a configuredResourceFetcherAdapter.Pure docs change — no behavior change.
Issue
Addresses item 4 of #1086.
Test plan
yarn typecheckpassesnpx eslint packages/react-native-executorch/src/utils/ResourceFetcher.tscleannpx prettier --check packages/react-native-executorch/src/utils/ResourceFetcher.tsclean