Skip to content

Commit

Permalink
docs: fix typos (#708)
Browse files Browse the repository at this point in the history
  • Loading branch information
afuetterer committed Sep 17, 2023
1 parent 3abfb7a commit 2698b0e
Show file tree
Hide file tree
Showing 14 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ RUN set -ex; \
apt-get install -y --no-install-recommends \
git-lfs

#install backported stable vesion of git, which supports ssh signing
# install backported stable version of git, which supports ssh signing
RUN echo "deb http://deb.debian.org/debian bullseye-backports main" >> /etc/apt/sources.list; \
apt-get update;\
apt-get install -y git/bullseye-backports
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ inputs:
description: "The ssh private key used to sign commits"
required: false

# `semantic-release version` comamnd line options
# `semantic-release version` command line options
prerelease:
type: string
required: false
Expand Down
2 changes: 1 addition & 1 deletion docs/algorithm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Implementation

1. Parse all the Git tags of the repository into semantic versions, and **sort**
in descending (most recent first) order according to `semver precedence`_.
Ignore any tags which do not correspond to valid semantic vesrions accroding
Ignore any tags which do not correspond to valid semantic vesrions according
to ``tag_format``.


Expand Down
4 changes: 2 additions & 2 deletions docs/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ For example, assuming a project is currently at version 1.2.3::
$ semantic-release version --minor --print
1.3.0

$ semantic-release verison --minor --print --build-metadata "run.12345"
$ semantic-release version --minor --print --build-metadata "run.12345"
1.3.0+run.12345

.. _cmd-version-option-commit:
Expand All @@ -211,7 +211,7 @@ For example, assuming a project is currently at version 1.2.3::
************************

Whether or not to perform a ``git commit`` on modifications to source files made by ``semantic-release`` during this
command invokation, and to run ``git tag`` on this new commit with a tag corresponding to the new version.
command invocation, and to run ``git tag`` on this new commit with a tag corresponding to the new version.

If ``--no-commit`` is supplied, a number of other options are also disabled; please see below.

Expand Down
8 changes: 4 additions & 4 deletions docs/commit-parsing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The default parser, which uses the `Angular commit style <https://github.com/ang
- Multiple ``BREAKING CHANGE:`` paragraphs are supported
- ``revert`` is not currently supported

The default confiugration options for
The default configuration options for
:py:class:`semantic_release.commit_parser.AngularCommitParser` are:

.. code-block:: toml
Expand Down Expand Up @@ -85,7 +85,7 @@ section.

The default settings are for `Gitmoji <https://gitmoji.carloscuesta.me/>`_.

The default confiugration options for
The default configuration options for
:py:class:`semantic_release.commit_parser.EmojiCommitParser` are:

.. code-block:: toml
Expand Down Expand Up @@ -128,7 +128,7 @@ A parser for `scipy-style commits <scipy-style>`_ with the following differences
a breaking change. Multiple ``BREAKING CHANGE`` paragraphs are supported.
- A scope (following the tag in parentheses) is supported

The default confiugration options for
The default configuration options for
:py:class:`semantic_release.commit_parser.ScipyCommitParser` are:

.. code-block:: toml
Expand Down Expand Up @@ -163,7 +163,7 @@ The default confiugration options for
The original parser from v1.0.0 of Python Semantic Release. Similar to the
emoji parser above, but with less features.

The default confiugration options for
The default configuration options for
:py:class:`semantic_release.commit_parser.TagCommitParser` are:

.. code-block:: toml
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ Tags which do not match this format will not be considered as versions of your p
"""""""""""""""""""""""""""""""""
Each entry represents a location where the version is stored in the source code,
specifed in ``file:variable`` format. For example:
specified in ``file:variable`` format. For example:
.. code-block:: toml
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ inspect the default configuration in your terminal by running

``semantic-release generate-config``

You can also use the :ref:`-f/--format <cmd-generate-config-option-format>` option to specify what foramt you would like this configuration
You can also use the :ref:`-f/--format <cmd-generate-config-option-format>` option to specify what format you would like this configuration
to be. The default is TOML, but JSON can also be used.

You can append the configuration to your existing ``pyproject.toml`` file using a standard redirect,
Expand Down
2 changes: 1 addition & 1 deletion docs/migrating_from_v7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ It is no longer possible to override arbitrary configuration values using the ``
file using :ref:`cmd-main-option-config` or via the available command-line options.

This simplifies the command-line option parsing significantly and is less error-prone,
which has resulted in previous issues (e.g. `#600`_) with overriddes on the command-line.
which has resulted in previous issues (e.g. `#600`_) with overrides on the command-line.
Some of the configuration values expected by Python Semantic Release use complex data
types such as lists or nested structures, which would be tedious and error-prone to
specify using just command-line options.
Expand Down
2 changes: 1 addition & 1 deletion docs/multibranch_releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Configuring Multibranch Releases
--------------------------------

Within your configuration file, you can create one or more groups of branches
(*"release groups"*) that produce a certain type of release. Options are confiugred
(*"release groups"*) that produce a certain type of release. Options are configured
at the group level, and the group to use is chosen based on the *current branch name*
against which Python Semantic Release is running.

Expand Down
2 changes: 1 addition & 1 deletion docs/strict_mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Strict Mode
Strict Mode is enabled by use of the :ref:`strict <cmd-main-option-strict>` parameter
to the main command for Python Semantic Release. Strict Mode alters the behaviour of
Python Semantic Release when certain conditions are encountered that prevent Python
Semantic Release from perfoming an action. Typically, this will result in a warning
Semantic Release from performing an action. Typically, this will result in a warning
becoming an error, or a different exit code (0 vs non-zero) being produced when Python
Semantic Release exits early.

Expand Down
2 changes: 1 addition & 1 deletion semantic_release/hvcs/_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ def create_release(

def get_release_id_by_tag(self, tag: str) -> int | None:
"""
Given a Git tag, return the ID (as the remote VCS defines it) of a corrsponding
Given a Git tag, return the ID (as the remote VCS defines it) of a corresponding
release in the remove VCS, if supported
"""
_not_supported(self, "get_release_id_by_tag")
Expand Down
2 changes: 1 addition & 1 deletion semantic_release/hvcs/gitlab.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def __init__(

@staticmethod
def _domain_from_environment() -> str | None:
"""Use Gitlab-CI environment varable to get the server domain, if available"""
"""Use Gitlab-CI environment variable to get the server domain, if available"""
if "CI_SERVER_URL" in os.environ:
url = urlsplit(os.environ["CI_SERVER_URL"])
return f"{url.netloc}{url.path}".rstrip("/")
Expand Down
2 changes: 1 addition & 1 deletion tests/const.py
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@ def _read_long_description():
EXAMPLE_CHANGELOG_MD_CONTENT = r"""
# CHANGELOG.md
## This is an example changlog
## This is an example changelog
## v1.0.0
* Various bugfixes, security enhancements
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/semantic_release/changelog/TEST_CHANGELOG.md.j2
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{#
NOTE: this changlog test doesn't include commit hashes from the default template as
NOTE: this changelog test doesn't include commit hashes from the default template as
they always change - which makes it notoriously difficult to check exact content
#}# CHANGELOG
{% if context.history.unreleased | length > 0 %}
Expand Down

0 comments on commit 2698b0e

Please sign in to comment.