Merge pull request #190 from commitizen-tools/unify-docstring-style

remove trailing space in keep_a_changelog and other minor improvement

Author: Lee-W

.github/workflows/pythonpackage.yml

@@ -12,7 +12,9 @@ jobs:
         python-version: [3.6, 3.7, 3.8]
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v1
       with:
@@ -27,6 +29,14 @@ jobs:
         git config --global user.email "action@github.com"
         git config --global user.name "GitHub Action"
         ./scripts/test
+    - name: Check commit
+      run: |
+        poetry run python -m commitizen check --rev-range ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }} || \
+        if [ $$? == 3 ] ; then
+          exit 0;
+        else
+          exit 1;
+        fi
     - name: Upload coverage to Codecov
       if: runner.os == 'Linux'
       uses: codecov/codecov-action@v1.0.3

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
@@ -137,7 +138,7 @@ def update_version_in_files(
     So for example, your tag could look like `v1.0.0` while your version in
     the package like `1.0.0`.
     """
-    # TODO: sepearte check step and write step
+    # TODO: separate check step and write step
     for location in files:
         filepath, *regexes = location.split(":", maxsplit=1)
         regex = regexes[0] if regexes else None
@@ -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/cli.py

@@ -114,7 +114,7 @@
                     {
                         "name": "--bump-message",
                         "help": (
-                            "template used to create the release commmit, "
+                            "template used to create the release commit, "
                             "useful when working with CI"
                         ),
                     },

commitizen/commands/bump.py

@@ -154,7 +154,7 @@ def __call__(self):  # noqa: C901
         self.config.set_key("version", new_version.public)
         c = git.commit(message, args=self._get_commit_args())
         if c.err:
-            out.error('git.commit errror: "{}"'.format(c.err.strip()))
+            out.error('git.commit error: "{}"'.format(c.err.strip()))
             raise SystemExit(COMMIT_FAILED)
         c = git.tag(new_tag_version)
         if c.err:

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/config/__init__.py

@@ -16,7 +16,7 @@ def load_global_conf() -> Optional[IniConfig]:
     if not global_cfg.exists():
         return None
 
-    # global conf doesnt make sense with commitizen bump
+    # global conf doesn't make sense with commitizen bump
     # so I'm deprecating it and won't test it
     message = (
         "Global conf will be deprecated in next major version. "

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/factory.py

@@ -11,7 +11,7 @@ def commiter_factory(config: BaseConfig) -> BaseCommitizen:
         _cz = registry[name](config)
     except KeyError:
         msg_error = (
-            "The commiter has not been found in the system.\n\n"
+            "The committer has not been found in the system.\n\n"
             f"Try running 'pip install {name}'\n"
         )
         out.error(msg_error)