Merge pull request #35 from shimakaze-git/master

v0.1.5
shimakaze-git · Jan 29, 2022 · 2b47d34 · 2b47d34
2 parents 6e2ca4e + 61a5e2a
commit 2b47d34
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 14 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -54,7 +54,7 @@ jobs:
           github_changelog_generator -u ${{ env.ACTOR }} \
                                     -p ${{ env.REPOSITORY }} \
                                     --header-label '# HISTORY' \
-                                    -t ${{ env.TOKEN }}
+                                    -t ${{ env.TOKEN }} \
                                     --output HISTORY.md
 
       - name: convert md to rst HISTORY.

diff --git a/jp_birthday/__init__.py b/jp_birthday/__init__.py
@@ -2,7 +2,7 @@
 
 __author__ = """shimakaze-git"""
 __email__ = "shimakaze.soft+github@googlemail.com"
-__version__ = "0.1.4"
+__version__ = "0.1.5"
 
 __copyright__ = "Copyright (C) 2020 shimakaze-git"
 __license__ = "MIT"

diff --git a/jp_birthday/managers.py b/jp_birthday/managers.py
@@ -89,6 +89,18 @@ def get_wareki_birthdays(self, wareki: str):
     def get_upcoming_birthdays(
         self, days=30, after=None, include_day=True, order=True, reverse=False
     ):
+        """[summary]
+
+        Args:
+            days (int, optional): [description]. Defaults to 30.
+            after ([type], optional): [description]. Defaults to None.
+            include_day (bool, optional): [description]. Defaults to True.
+            order (bool, optional): [description]. Defaults to True.
+            reverse (bool, optional): [description]. Defaults to False.
+
+        Returns:
+            [type]: [description]
+        """
         # 今後の誕生日
 
         birthdays = self.filter()
@@ -132,6 +144,14 @@ def get_upcoming_birthdays(
         return birthdays
 
     def get_birthdays(self, day=None):
+        """[summary]
+
+        Args:
+            day ([type], optional): [description]. Defaults to None.
+
+        Returns:
+            [type]: [description]
+        """
         if not day:
             day = date.today()
 

diff --git a/jp_birthday/models.py b/jp_birthday/models.py
@@ -8,11 +8,7 @@
 
 
 class BaseBirthdayModel(models.Model):
-    """[summary]
-
-    Args:
-        models ([type]): [description]
-    """
+    """BaseBirthdayModel"""
 
     objects = JpBirthdayManager()
     birthday = BirthdayField()
@@ -69,6 +65,14 @@ def _get_wareki_birthday(self) -> dict:
         }
 
     def get_wareki_birthday(self, dict_type=False) -> object:
+        """get wareki birthday
+
+        Args:
+            dict_type (bool, optional): 辞書型で返すか文字列で返すかのフォーマト指定. Defaults to False.
+
+        Returns:
+            object: dictで返すか文字列で返すのどちらかになる.
+        """
         wareki_birthday = self._get_wareki_birthday()
         if not dict_type:
             wareki = wareki_birthday["era_short"]
@@ -79,10 +83,12 @@ def get_wareki_birthday(self, dict_type=False) -> object:
         return wareki_birthday
 
     def get_age(self) -> int:
-        """[summary]
+        """get age from birthday.
+
+        誕生日を元に年齢を割り出して返す.
 
         Returns:
-            [type]: [description]
+            int: age.
         """
         today = date.today()
 
@@ -98,11 +104,7 @@ def get_age(self) -> int:
 
 
 class BirthdayModel(BaseBirthdayModel):
-    """[summary]
-
-    Args:
-        BaseBirthdayModel ([type]): [description]
-    """
+    """BirthdayModel"""
 
     class Meta:
         abstract = True