integrate autodoc return values

pull/397/head
halcy 2025-02-14 03:00:14 +02:00
rodzic a56dfcf295
commit 7c5d8f3e29
5 zmienionych plików z 5679 dodań i 773 usunięć

Plik diff jest za duży Load Diff

Wyświetl plik

@ -19,7 +19,7 @@ class Mastodon(Internals):
def admin_accounts_v2(self, origin: Optional[str] = None, by_domain: Optional[str] = None, status: Optional[str] = None, username: Optional[str] = None, def admin_accounts_v2(self, origin: Optional[str] = None, by_domain: Optional[str] = None, status: Optional[str] = None, username: Optional[str] = None,
display_name: Optional[str] = None, email: Optional[str] = None, ip: Optional[str] = None, permissions: Optional[str] = None, display_name: Optional[str] = None, email: Optional[str] = None, ip: Optional[str] = None, permissions: Optional[str] = None,
invited_by: Union[Account, IdType] = None, role_ids: Optional[List[IdType]] = None, max_id: Optional[IdType] = None, min_id: Optional[IdType] = None, invited_by: Union[Account, IdType] = None, role_ids: Optional[List[IdType]] = None, max_id: Optional[IdType] = None, min_id: Optional[IdType] = None,
since_id: Optional[IdType] = None, limit: Optional[int] = None) -> AdminAccount: since_id: Optional[IdType] = None, limit: Optional[int] = None) -> List[AdminAccount]:
""" """
Fetches a list of accounts that match given criteria. By default, local accounts are returned. Fetches a list of accounts that match given criteria. By default, local accounts are returned.

Wyświetl plik

@ -2655,7 +2655,7 @@ class InstanceV2(AttribAccessDict):
icon: "EntityList[InstanceIcon]" icon: "EntityList[InstanceIcon]"
""" """
The instance icon, as a list of `InstanceIcon`s, with entries representing different available size variants. The instance icon, as a list of `InstanceIcon` , with entries representing different available size variants.
Should contain (as text): URL Should contain (as text): URL
Version history: Version history:

Wyświetl plik

@ -362,8 +362,9 @@ class NonPaginatableList(List[T]):
""" """
pass pass
"""Lists in Mastodon.py are either regular or paginatable"""
EntityList = Union[NonPaginatableList[T], PaginatableList[T]] EntityList = Union[NonPaginatableList[T], PaginatableList[T]]
"""Lists in Mastodon.py are either regular or paginatable, so this is a union of
:class:`NonPaginatableList` and :class:`PaginatableList`."""
try: try:
OrderedStrDict = OrderedDict[str, Any] OrderedStrDict = OrderedDict[str, Any]
@ -510,14 +511,15 @@ class AttribAccessDict(OrderedStrDict):
pass pass
return False return False
"""An entity returned by the Mastodon API is either a dict or a list"""
Entity = Union[AttribAccessDict, EntityList] Entity = Union[AttribAccessDict, EntityList]
"""Base class for everything returned by the API. This is a union of :class:`AttribAccessDict` and :class:`EntityList`."""
"""A type containing the parameters for a encrypting webpush data. Considered opaque / implementation detail."""
WebpushCryptoParamsPubkey = Dict[str, str] WebpushCryptoParamsPubkey = Dict[str, str]
"""A type containing the parameters for a encrypting webpush data. Considered opaque / implementation detail."""
"""A type containing the parameters for a derypting webpush data. Considered opaque / implementation detail."""
WebpushCryptoParamsPrivkey = Dict[str, str] WebpushCryptoParamsPrivkey = Dict[str, str]
"""A type containing the parameters for a derypting webpush data. Considered opaque / implementation detail."""
"""Backwards compatibility alias"""
AttribAccessList = PaginatableList AttribAccessList = PaginatableList
"""Backwards compatibility alias"""