chore: update docstring

pull/109/head
yupix 7 months ago
parent 6e7fd405b9
commit 4c69fc5220
No known key found for this signature in database
GPG Key ID: 2FF705F5C56D9C06

@ -262,25 +262,23 @@ class FileActions(ClientFileActions):
until_id: str | None = None, until_id: str | None = None,
limit: int = 10, limit: int = 10,
) -> list[Note]: ) -> list[Note]:
"""Get the attached notes of a file """指定したファイルを含む全てのノートを取得します
Endpoint: `/api/drive/files/attached-notes`
Parameters Parameters
---------- ----------
file_id: str file_id: str
The id of the file to get notes from ートを取得するファイルID
since_id: str | None since_id: str | None
The id of the note to start from, defaults to None 指定するとそのートIDよりも後のートを返します, default=None
until_id: str | None until_id: str | None
The id of the note to end at, defaults to None 指定するとそのートIDよりも前のートを返します, default=None
limit: int limit: int
The amount of notes to get, defaults to 10 一度に取得するノート数, default=10
Returns Returns
------- -------
list[Note] list[Note]
The attached notes of the file 取得したノート
""" """
return await super().get_attached_notes( return await super().get_attached_notes(
@ -295,24 +293,42 @@ class FileActions(ClientFileActions):
until_id: str | None = None, until_id: str | None = None,
limit: int = 10, limit: int = 10,
) -> AsyncGenerator[Note, None]: ) -> AsyncGenerator[Note, None]:
"""指定したファイルを含む全てのノートを取得します
Parameters
----------
file_id: str
ートを取得するファイルID
since_id: str | None
指定するとそのートIDよりも後のートを返します, default=None
until_id: str | None
指定するとそのートIDよりも前のートを返します, default=None
limit: int
一度に取得するノート数, default=10
Returns
-------
AsyncGenerator[Note, None]
取得したノート
"""
async for i in super().get_all_attached_notes(since_id, until_id, limit, file_id=file_id): async for i in super().get_all_attached_notes(since_id, until_id, limit, file_id=file_id):
yield i yield i
@credentials_required @credentials_required
async def check_existence(self, md5: str) -> bool: async def check_existence(self, md5: str) -> bool:
"""Check if a file exists in the drive """指定したmd5のファイルが既に存在するか確認します
Endpoint: `/api/drive/files/check-existence` Endpoint: `/api/drive/files/check-existence`
Parameters Parameters
---------- ----------
md5: str md5: str
The md5 of the file to check 確認したいmd5
Returns Returns
------- -------
bool bool
Whether the file exists or not 存在するかしないか
""" """
data = {"md5": md5} data = {"md5": md5}

Loading…
Cancel
Save