Skip to content

Commit 2b93cef

Browse files
Add docstring to revision param for downloadFile (#714)
Copies the docstring in the [Python counterpart](https://huggingface.co/docs/huggingface_hub/v0.23.1/en/package_reference/hf_api#huggingface_hub.HfApi.hf_hub_download) --------- Co-authored-by: Eliott C <[email protected]>
1 parent 8fe92c7 commit 2b93cef

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

packages/hub/src/lib/download-file.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ export async function downloadFile(params: {
1616
* For example, when calling on a file stored with Git LFS, the pointer file will be downloaded instead.
1717
*/
1818
raw?: boolean;
19+
/**
20+
* An optional Git revision id which can be a branch name, a tag, or a commit hash.
21+
*
22+
* @default "main"
23+
*/
1924
revision?: string;
2025
/**
2126
* Fetch only a specific part of the file

0 commit comments

Comments
 (0)