style(docstring): unify docstring style

Author: Lee-W

commitizen/bump.py

@@ -55,7 +55,8 @@ def find_increment(
 
 
 def prerelease_generator(current_version: str, prerelease: Optional[str] = None) -> str:
-    """
+    """Generate prerelease
+
     X.YaN   # Alpha release
     X.YbN   # Beta release
     X.YrcN  # Release Candidate
@@ -179,13 +180,11 @@ def create_tag(version: Union[Version, str], tag_format: Optional[str] = None):
     That's why this function exists.
 
     Example:
-
     | tag | version (PEP 0440) |
     | --- | ------- |
     | v0.9.0 | 0.9.0 |
     | ver1.0.0 | 1.0.0 |
     | ver1.0.0.a0 | 1.0.0a0 |
-
     """
     if isinstance(version, str):
         version = Version(version)

commitizen/changelog.py

@@ -1,5 +1,4 @@
-"""
-# DESIGN
+"""Design
 
 ## Metadata CHANGELOG.md
 
@@ -62,7 +61,6 @@ def transform_change_type(change_type: str) -> str:
 
 
 def get_commit_tag(commit: GitCommit, tags: List[GitTag]) -> Optional[GitTag]:
-    """"""
     return next((tag for tag in tags if tag.rev == commit.rev), None)
 
 
@@ -211,13 +209,13 @@ def incremental_build(new_content: str, lines: List, metadata: Dict) -> List:
     The metadata holds information enough to remove the old unreleased and
     where to place the new content
 
-    Arguments:
-        lines -- the lines from the changelog
-        new_content -- this should be placed somewhere in the lines
-        metadata -- information about the changelog
+    Args:
+        lines: The lines from the changelog
+        new_content: This should be placed somewhere in the lines
+        metadata: Information about the changelog
 
     Returns:
-        List -- updated lines
+        Updated lines
     """
     unreleased_start = metadata.get("unreleased_start")
     unreleased_end = metadata.get("unreleased_end")

commitizen/changelog_parser.py

@@ -1,5 +1,4 @@
-"""
-# DESIGN
+"""CHNAGLOG PARSER DESIGN
 
 ## Parse CHANGELOG.md
 
@@ -36,8 +35,7 @@
 
 
 def find_version_blocks(filepath: str) -> Generator:
-    """
-    version block: contains all the information about a version.
+    """Find version block (version block: contains all the information about a version.)
 
     E.g:
     ```

commitizen/commands/check.py

@@ -12,16 +12,12 @@ class Check:
     """Check if the current commit msg matches the commitizen format."""
 
     def __init__(self, config: BaseConfig, arguments: Dict[str, str], cwd=os.getcwd()):
-        """Init method.
-
-        Parameters
-        ----------
-        config : BaseConfig
-            the config object required for the command to perform its action
-        arguments : dict
-            the arguments object that contains all
-            the flags provided by the user
+        """Initial check command.
 
+        Args:
+            config: The config object required for the command to perform its action
+            arguments: All the flags provided by the user
+            cwd: Current work directory
         """
         self.commit_msg_file: Optional[str] = arguments.get("commit_msg_file")
         self.rev_range: Optional[str] = arguments.get("rev_range")
@@ -44,11 +40,8 @@ def _valid_command_argument(self):
     def __call__(self):
         """Validate if commit messages follows the conventional pattern.
 
-        Raises
-        ------
-        SystemExit
-            if the commit provided not follows the conventional pattern
-
+        Raises:
+            SystemExit: if the commit provided not follows the conventional pattern
         """
         commit_msgs = self._get_commit_messages()
         if not commit_msgs:

commitizen/cz/base.py

@@ -69,7 +69,7 @@ def schema(self) -> Optional[str]:
         raise NotImplementedError("Not Implemented yet")
 
     def schema_pattern(self) -> Optional[str]:
-        """Regex matching the schema used for message validation"""
+        """Regex matching the schema used for message validation."""
         raise NotImplementedError("Not Implemented yet")
 
     def info(self) -> Optional[str]:

commitizen/git.py

@@ -63,9 +63,7 @@ def get_commits(
     delimiter: str = "----------commit-delimiter----------",
     args: str = "",
 ) -> List[GitCommit]:
-    """
-    Get the commits betweeen start and end
-    """
+    """Get the commits betweeen start and end."""
     git_log_cmd = f"git log --pretty={log_format}{delimiter} {args}"
 
     if start:
@@ -133,7 +131,7 @@ def find_git_project_root() -> Optional[Path]:
 
 
 def is_staging_clean() -> bool:
-    """Check if staing is clean"""
+    """Check if staing is clean."""
     c = cmd.run("git diff --no-ext-diff --name-only")
     c_cached = cmd.run("git diff --no-ext-diff --cached --name-only")
     return not (bool(c.out) or bool(c_cached.out))