From d51b999a245a4e56ff7a09d0495c75336f2f150d Mon Sep 17 00:00:00 2001 From: DeveloperC <65925405+DeveloperC286@users.noreply.github.com> Date: Sun, 31 Jan 2021 16:04:58 +0000 Subject: [PATCH] docs: correct casing on proper nouns (#320) * docs: correcting Semantic Versioning casing Semantic Versioning is the name of the specification. Therefore it is a proper noun. This patch corrects the incorrect casing for Semantic Versioning. * docs: correcting Python casing This patch corrects the incorrect casing for Python. --- README.rst | 2 +- action.yml | 2 +- docs/commit-log-parsing.rst | 2 +- docs/index.rst | 2 +- setup.py | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 0c8e3b455..b788eadf6 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ Python Semantic Release |Test Status| |PyPI Version| |conda-forge version| |Read the Docs Status| -Automatic semantic versioning for python projects. This is a python +Automatic Semantic Versioning for Python projects. This is a Python implementation of `semantic-release`_ for JS by Stephan Bönnemann. If you find this topic interesting you should check out his `talk from JSConf Budapest`_. diff --git a/action.yml b/action.yml index e47aa0489..6eec23b81 100644 --- a/action.yml +++ b/action.yml @@ -1,6 +1,6 @@ name: 'Python Semantic Release' -description: 'Automatic semantic versioning for python projects' +description: 'Automatic Semantic Versioning for Python projects' inputs: directory: diff --git a/docs/commit-log-parsing.rst b/docs/commit-log-parsing.rst index ba594852d..b7b88e786 100644 --- a/docs/commit-log-parsing.rst +++ b/docs/commit-log-parsing.rst @@ -39,7 +39,7 @@ Writing your own parser If you think this is all well and cool, but the angular style is not for you, no need to worry because custom parsers are supported. -A parser is basically a python function that takes the commit message as the +A parser is basically a Python function that takes the commit message as the only argument and returns the information extracted from the commit. The format of the output should be a :py:class:`semantic_release.history.parser_helpers.ParsedCommit` object with the following parameters:: diff --git a/docs/index.rst b/docs/index.rst index 5b68c1f7a..478f35fca 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -28,7 +28,7 @@ your project, for example ``setup.py``:: ) Python Semantic Release is configured using ``setup.cfg`` or ``pyproject.toml``. -Set :ref:`config-version_variable` to the location of your version variable inside any python file:: +Set :ref:`config-version_variable` to the location of your version variable inside any Python file:: [semantic_release] version_variable = setup.py:__version__ diff --git a/setup.py b/setup.py index 5165d7a65..9d1feb682 100644 --- a/setup.py +++ b/setup.py @@ -29,7 +29,7 @@ def _read_long_description(): url="http://github.com/relekang/python-semantic-release", author="Rolf Erik Lekang", author_email="me@rolflekang.com", - description="Automatic semantic versioning for python projects", + description="Automatic Semantic Versioning for Python projects", long_description=_read_long_description(), packages=find_packages(exclude=("tests",)), license="MIT",