Skip to content

Commit

Permalink
Minor doc fixes (#1775)
Browse files Browse the repository at this point in the history
* Don't use `api` in `list_repo_refs` example.

* Minor typo fssepc -> fsspec

* Use `.item_object_id` instead of `._id`
  • Loading branch information
pcuenca authored Oct 24, 2023
1 parent d641072 commit ef48c7f
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/source/de/guides/repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Sie können auch die vorhandenen git-Referenzen von einem Repository mit [`list_

```py
>>> from huggingface_hub import list_repo_refs
>>> api.list_repo_refs("bigcode/the-stack", repo_type="dataset")
>>> list_repo_refs("bigcode/the-stack", repo_type="dataset")
GitRefs(
branches=[
GitRefInfo(name='main', ref='refs/heads/main', target_commit='18edc1591d9ce72aa82f56c4431b3c969b210ae3'),
Expand Down
2 changes: 1 addition & 1 deletion docs/source/en/guides/repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ You can also list the existing git refs from a repository using [`list_repo_refs

```py
>>> from huggingface_hub import list_repo_refs
>>> api.list_repo_refs("bigcode/the-stack", repo_type="dataset")
>>> list_repo_refs("bigcode/the-stack", repo_type="dataset")
GitRefs(
branches=[
GitRefInfo(name='main', ref='refs/heads/main', target_commit='18edc1591d9ce72aa82f56c4431b3c969b210ae3'),
Expand Down
4 changes: 2 additions & 2 deletions docs/source/en/package_reference/hf_file_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ rendered properly in your Markdown viewer.

# Filesystem API

The `HfFileSystem` class provides a pythonic file interface to the Hugging Face Hub based on [`fssepc`](https://filesystem-spec.readthedocs.io/en/latest/).
The `HfFileSystem` class provides a pythonic file interface to the Hugging Face Hub based on [`fsspec`](https://filesystem-spec.readthedocs.io/en/latest/).

## HfFileSystem

`HfFileSystem` is based on [fsspec](https://filesystem-spec.readthedocs.io/en/latest/), so it is compatible with most of the APIs that it offers. For more details, check out [our guide](../guides/hf_file_system) and the fsspec's [API Reference](https://filesystem-spec.readthedocs.io/en/latest/api.html#fsspec.spec.AbstractFileSystem).
`HfFileSystem` is based on [fsspec](https://filesystem-spec.readthedocs.io/en/latest/), so it is compatible with most of the APIs that it offers. For more details, check out [our guide](../guides/hf_file_system) and fsspec's [API Reference](https://filesystem-spec.readthedocs.io/en/latest/api.html#fsspec.spec.AbstractFileSystem).

[[autodoc]] HfFileSystem
- __init__
Expand Down
2 changes: 1 addition & 1 deletion src/huggingface_hub/hf_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -6318,7 +6318,7 @@ def update_collection_item(
Slug of the collection to update. Example: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`.
item_object_id (`str`):
ID of the item in the collection. This is not the id of the item on the Hub (repo_id or paper id).
It must be retrieved from a [`CollectionItem`] object. Example: `collection.items[0]._id`.
It must be retrieved from a [`CollectionItem`] object. Example: `collection.items[0].item_object_id`.
note (`str`, *optional*):
A note to attach to the item in the collection. The maximum size for a note is 500 characters.
position (`int`, *optional*):
Expand Down

0 comments on commit ef48c7f

Please sign in to comment.