refactor: update docstrings and rename some variables

shikithon/api.py

@@ -1,7 +1,7 @@
 """Shikithon API Module.
 
 This is main module with a class
-for interacting with the Shikimori API.
+for interacting with the Shikimori API
 """
 import sys
 from typing import Optional, TypeVar
@@ -23,7 +23,7 @@ class ShikimoriAPI(Client):
     """Main class for interacting with the API.
 
     Current API class uses base client for interacting with API.
-    Also, all API methods splitted up to resources for convinient usage.
+    Also, all API methods splitted up to resources for convinient usage
     """
 
     __slots__ = ('achievements', 'animes', 'appears', 'bans', 'calendars',

shikithon/decorators/method_endpoint.py

@@ -35,7 +35,7 @@ def endpoint_logger_wrapper(
         @wraps(function)
         async def endpoint_logger_wrapped(*args: P.args,
                                           **kwargs: P.kwargs) -> R:
-            """Decorator's wrapped function for logging endpoint of method
+            """Decorator's wrapped function for logging endpoint of method.
 
             :param args: Positional arguments
             :type args: P.args

shikithon/enums/anime.py

@@ -1,4 +1,4 @@
-"""Enums for /api/animes."""
+"""Enums for `/api/animes`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/club.py

@@ -1,4 +1,4 @@
-"""Enums for /api/clubs."""
+"""Enums for `/api/clubs`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/comment.py

@@ -1,4 +1,4 @@
-"""Enums for /api/comments."""
+"""Enums for `/api/comments`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/enhanced_enum.py

@@ -5,7 +5,7 @@
 class EnhancedEnum(Enum):
     """Enhanced enum class.
 
-    Adds support for __str__ for getting enum value
+    Adds support for `__str__` for getting enum value
     when casting to string or using in f-string, etc.
     """
 

shikithon/enums/favorite.py

@@ -1,4 +1,4 @@
-"""Enums for /api/favorites."""
+"""Enums for `/api/favorites`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/history.py

@@ -1,4 +1,4 @@
-"""Enums for /api/users/:id/history"""
+"""Enums for `/api/users/:id/history`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/manga.py

@@ -1,4 +1,4 @@
-"""Enums for /api/mangas."""
+"""Enums for `/api/mangas`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/message.py

@@ -1,4 +1,4 @@
-"""Enums for /api/users/:id/messages"""
+"""Enums for `/api/users/:id/messages`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/person.py

@@ -1,4 +1,4 @@
-"""Enums for /api/person and /api/favorites."""
+"""Enums for `/api/person` and `/api/favorites`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/ranobe.py

@@ -1,4 +1,4 @@
-"""Enums for /api/ranobe."""
+"""Enums for `/api/ranobe`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/review.py

@@ -1,4 +1,4 @@
-"""Enums for /api/reviews"""
+"""Enums for `/api/reviews`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/style.py

@@ -1,4 +1,4 @@
-"""Enums for /api/styles."""
+"""Enums for `/api/styles`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/topic.py

@@ -1,4 +1,4 @@
-"""Enums for /api/topics."""
+"""Enums for `/api/topics`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/user_rate.py

@@ -1,4 +1,4 @@
-"""Enums for /api/user_rates."""
+"""Enums for `/api/user_rates` and `/api/v2/user_rates`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/enums/video.py

@@ -1,4 +1,4 @@
-"""Enums for /api/animes/:anime_id/videos."""
+"""Enums for `/api/animes/:anime_id/videos`."""
 from .enhanced_enum import EnhancedEnum
 
 

shikithon/exceptions/store_exception.py

@@ -1,4 +1,4 @@
-"""Exception for raising on store method erros."""
+"""Exception for raising on store method errors."""
 
 from loguru import logger
 

shikithon/models/abuse_response.py

@@ -1,4 +1,4 @@
-"""Model for api/v2/abuse_requests"""
+"""Model for `api/v2/abuse_requests`."""
 from typing import List
 
 from pydantic import BaseModel

shikithon/models/achievement.py

@@ -1,4 +1,4 @@
-"""Model for /api/achievements"""
+"""Model for `/api/achievements`."""
 from datetime import datetime
 
 from pydantic import BaseModel

shikithon/models/activity.py

@@ -1,4 +1,4 @@
-"""Submodel for stats.py"""
+"""Submodel for `stats.py`."""
 from typing import List
 
 from pydantic import BaseModel

shikithon/models/anime.py

@@ -1,4 +1,4 @@
-"""Model for /api/animes"""
+"""Model for `/api/animes`."""
 from datetime import date, datetime
 from typing import List, Optional
 

shikithon/models/ban.py

@@ -1,4 +1,4 @@
-"""Model for /api/bans"""
+"""Model for `/api/bans`."""
 from datetime import datetime
 from typing import Optional
 

shikithon/models/calendar_event.py

@@ -1,4 +1,4 @@
-"""Model for /api/calendar"""
+"""Model for `/api/calendar`."""
 from datetime import datetime
 from typing import Optional
 

shikithon/models/character.py

@@ -1,4 +1,4 @@
-"""Submodel for creator.py"""
+"""Submodel for `creator.py`."""
 from datetime import datetime
 from typing import List, Optional, Union
 

shikithon/models/club.py

@@ -1,4 +1,4 @@
-"""Model for /api/clubs"""
+"""Model for `/api/clubs`."""
 from typing import List, Optional
 
 from pydantic import BaseModel

shikithon/models/club_image.py

@@ -1,4 +1,4 @@
-"""Model for /api/clubs/:id/images"""
+"""Model for `/api/clubs/:id/images`."""
 from typing import Optional
 
 from pydantic import BaseModel

shikithon/models/comment.py

@@ -1,4 +1,4 @@
-"""Submodel for ban.py and model for /api/comments"""
+"""Submodel for `ban.py` and model for `/api/comments`."""
 from datetime import datetime
 
 from pydantic import BaseModel
@@ -9,7 +9,8 @@
 class CommentInfo(BaseModel):
     """Represents a comment info entity.
 
-    Used for ban.py model."""
+    Used for `ban.py` model
+    """
     id: int
     user_id: int
     commentable_id: int
@@ -23,7 +24,8 @@ class CommentInfo(BaseModel):
 class Comment(CommentInfo):
     """Represents a comment entity.
 
-    Used for api/comments."""
+    Used for `/api/comments`
+    """
     html_body: str
     can_be_edited: bool
     user: UserInfo

shikithon/models/constants.py

@@ -1,4 +1,4 @@
-"""Model for /api/constants"""
+"""Model for `/api/constants`."""
 from typing import Tuple, Literal
 
 from pydantic import BaseModel

shikithon/models/created_user_image.py

@@ -1,4 +1,4 @@
-"""Model for /api/user_images"""
+"""Model for `/api/user_images`."""
 from pydantic import BaseModel
 
 

shikithon/models/critique.py

@@ -1,4 +1,4 @@
-"""Submodel for topic.py"""
+"""Submodel for `topic.py`."""
 from datetime import datetime
 from typing import Optional, Union
 

shikithon/models/date.py

@@ -1,13 +1,13 @@
-"""Submodel for people.py"""
+"""Submodel for `people.py`."""
 from typing import Optional
 
 from pydantic import BaseModel
 
 
 class Date(BaseModel):
-    """Date model class.
+    """Date object model.
 
-    Used to represent birthday or decease of person.
+    Used to represent birthday or decease of person
     """
     day: Optional[int]
     month: Optional[int]

shikithon/models/dialog.py

@@ -1,4 +1,4 @@
-"""Model for api/dialogs"""
+"""Model for `/api/dialogs`."""
 from pydantic import BaseModel
 
 from .message import MessageInfo

shikithon/models/favourite.py

@@ -1,4 +1,4 @@
-"""Submodel for favourites.py"""
+"""Submodel for `favourites.py`."""
 from typing import Optional
 
 from pydantic import BaseModel

shikithon/models/favourites.py

@@ -1,4 +1,4 @@
-"""Model for /api/users/:id/favorites"""
+"""Model for `/api/users/:id/favorites`."""
 from typing import List
 
 from pydantic import BaseModel

shikithon/models/forum.py

@@ -1,4 +1,4 @@
-"""Model for api/forums"""
+"""Model for `/api/forums`."""
 from pydantic import BaseModel
 
 

shikithon/models/franchise_tree.py

@@ -1,4 +1,4 @@
-"""Model for /api/animes|mangas|ranobe/:id/franchise"""
+"""Model for `/api/animes|mangas|ranobe/:id/franchise`."""
 from typing import List
 
 from pydantic import BaseModel

shikithon/models/genre.py

@@ -1,4 +1,4 @@
-"""Submodel for anime.py"""
+"""Submodel for `anime.py`."""
 from typing import Optional
 
 from pydantic import BaseModel

shikithon/models/history.py

@@ -1,4 +1,4 @@
-"""Model for /api/users/:id/history"""
+"""Model for `/api/users/:id/history`."""
 from datetime import datetime
 from typing import Optional, Union
 

shikithon/models/link.py

@@ -1,4 +1,4 @@
-"""Model for /api/animes/:id/external_links"""
+"""Model for `/api/animes/:id/external_links`."""
 from datetime import datetime
 from typing import Optional
 

shikithon/models/linked_topic.py

@@ -1,4 +1,4 @@
-"""Submodel for message.py"""
+"""Submodel for `message.py`."""
 from datetime import date
 from typing import Optional
 

shikithon/models/logo.py

@@ -1,4 +1,4 @@
-"""Submodel for club.py"""
+"""Submodel for `club.py`."""
 from pydantic import BaseModel
 
 

shikithon/models/manga.py

@@ -1,4 +1,4 @@
-"""Model for /api/mangas"""
+"""Model for `/api/mangas`."""
 from datetime import date
 from typing import List, Optional
 

shikithon/models/message.py

@@ -1,4 +1,4 @@
-"""Model for /api/messages and submodel for dialog.py"""
+"""Model for `/api/messages` and submodel for `dialog.py`."""
 from datetime import datetime
 from typing import Optional
 

shikithon/models/person.py

@@ -1,4 +1,4 @@
-"""Model for /api/people and submodel for creator.py"""
+"""Model for `/api/people` and submodel for `creator.py`."""
 from datetime import datetime
 from typing import List, Optional, Tuple
 

shikithon/models/publisher.py

@@ -1,4 +1,4 @@
-"""Model for /api/publishers"""
+"""Model for `/api/publishers`."""
 from pydantic import BaseModel
 
 

shikithon/models/ranobe.py

@@ -1,4 +1,4 @@
-"""Model for /api/ranobe"""
+"""Model for `/api/ranobe`."""
 from datetime import date
 from typing import List, Optional
 

shikithon/models/rating.py

@@ -1,4 +1,4 @@
-"""Submodel for rating_list.py"""
+"""Submodel for `rating_list.py`."""
 from pydantic import BaseModel
 
 

shikithon/models/rating_list.py

@@ -1,4 +1,4 @@
-"""Submodel for stats.py"""
+"""Submodel for `stats.py`."""
 from typing import List, Optional
 
 from pydantic import BaseModel

shikithon/models/relation.py

@@ -1,4 +1,4 @@
-"""Model for /api/animes|mangas|ranobe/:id/related"""
+"""Model for `/api/animes|mangas|ranobe/:id/related`."""
 from typing import Optional, Union
 
 from pydantic import BaseModel

shikithon/models/review.py

@@ -1,4 +1,4 @@
-"""Model for /api/reviews"""
+"""Model for `/api/reviews`."""
 from datetime import datetime
 from typing import Literal, Optional, Union
 

shikithon/models/role.py

@@ -1,4 +1,4 @@
-"""Model for api/animes|mangas|ranobe/:id/roles"""
+"""Model for `/api/animes|mangas|ranobe/:id/roles`."""
 from typing import List, Optional
 
 from pydantic import BaseModel

shikithon/models/roles.py

@@ -1,4 +1,4 @@
-"""Submodel for people.py"""
+"""Submodel for `people.py`."""
 from typing import List
 
 from pydantic import BaseModel

shikithon/models/score.py

@@ -1,4 +1,4 @@
-"""Submodel for score_list.py"""
+"""Submodel for `score_list.py`."""
 from pydantic import BaseModel
 
 

shikithon/models/score_list.py

@@ -1,4 +1,4 @@
-"""Submodel for stats.py"""
+"""Submodel for `stats.py`."""
 from typing import List
 
 from pydantic import BaseModel

shikithon/models/screenshot.py

@@ -1,4 +1,4 @@
-"""Submodel for anime.py"""
+"""Submodel for `anime.py`."""
 from pydantic import BaseModel
 
 

shikithon/models/seyu.py

@@ -1,4 +1,4 @@
-"""Submodel for character.py"""
+"""Submodel for `character.py`."""
 from pydantic import BaseModel
 
 from .image import Image

shikithon/models/stats.py

@@ -1,4 +1,4 @@
-"""Submodel for user.py"""
+"""Submodel for `user.py`."""
 from typing import Dict, List, Optional, Union
 
 from pydantic import BaseModel, Field