From c3cd386de68721815451e8ba7cf4560d8d1c6ff6 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Fri, 16 Feb 2024 16:27:20 +0100 Subject: [PATCH] Fix typos (#1995) * fix typo * fix typo * fix typo * fix typo * fix typo --- CONTRIBUTING.rst | 2 +- README.rst | 2 +- docs/coding_style.rst | 2 +- docs/communityproviders.rst | 2 +- docs/writing-docs.rst | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 862a29ec76..39e9cd7609 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -24,7 +24,7 @@ Making Changes the new branch with ``git checkout fix/master/my_contribution``. Please avoid working directly on the ``master`` branch. - Make commits of logical units. -- Follow our `coding style`_. Your can run ``make lint`` to format your code. +- Follow our `coding style`_. You can run ``make lint`` to format your code. - Check for unnecessary whitespace with ``git diff --check`` before committing. - Make sure you have added the necessary tests for your changes. diff --git a/README.rst b/README.rst index 86bdae66ce..9bceeeccda 100644 --- a/README.rst +++ b/README.rst @@ -380,7 +380,7 @@ Seeding the Generator --------------------- When using Faker for unit testing, you will often want to generate the same -data set. For convenience, the generator also provide a ``seed()`` method, +data set. For convenience, the generator also provides a ``seed()`` method, which seeds the shared random number generator. A Seed produces the same result when the same methods with the same version of faker are called. diff --git a/docs/coding_style.rst b/docs/coding_style.rst index 433d8a1c59..a0263b7404 100644 --- a/docs/coding_style.rst +++ b/docs/coding_style.rst @@ -19,7 +19,7 @@ For each data set, please provide a comment with reference to the source and/or origin of the data. We only accept new data if it's coming from statistical sources, such as census or government institutions. -This include names and their distribution. +This includes names and their distribution. Name Lists diff --git a/docs/communityproviders.rst b/docs/communityproviders.rst index ed354349df..e568acb3c3 100644 --- a/docs/communityproviders.rst +++ b/docs/communityproviders.rst @@ -68,7 +68,7 @@ Here's a list of Providers written by the community: If you want to add your own provider to this list, please submit a Pull Request to our `repo`_. -In order to be included, your provider must satisfy these requirement: +In order to be included, your provider must satisfy these requirements: * it must have tests. * it must be published on PyPI. diff --git a/docs/writing-docs.rst b/docs/writing-docs.rst index 714b165939..594be65901 100644 --- a/docs/writing-docs.rst +++ b/docs/writing-docs.rst @@ -85,7 +85,7 @@ specify ``:sample seed=12345: a=2``, the sample usage section generated will loo You can mix and match ``SIZE``, ``SEED``, and ``KWARGS``, and if ``KWARGS`` is becoming too long to fit a single line, you can break ``KWARGS`` into multiple lines in the same way you can break keyword -arguments across multiples lines in actual Python code. For example, let us say the docstring contains +arguments across multiple lines in actual Python code. For example, let us say the docstring contains this: .. code-block:: text