From 1102faffd826e4906789d601995dbcbefdf1cf15 Mon Sep 17 00:00:00 2001 From: fcurella Date: Tue, 14 Jan 2020 09:29:45 -0600 Subject: [PATCH] Format README.rst --- README.rst | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 75b3f067d1..cbfbb55d1e 100644 --- a/README.rst +++ b/README.rst @@ -19,8 +19,8 @@ Faker is heavily inspired by `PHP Faker`_, `Perl Faker`_, and by `Ruby Faker`_. ---- -For more details, see the `extended docs`_, especially if you are upgrading from -version ``2.0.4`` and below as there might be breaking changes. +For more details, see the `extended docs`_, especially if you are upgrading +from version ``2.0.4`` and below as there might be breaking changes. Basic Usage ----------- @@ -230,13 +230,16 @@ Where: - ``-s SEP``: will generate the specified separator after each generated output -- ``-i {my.custom_provider other.custom_provider}`` list of additional custom providers to use. - Note that is the import path of the package containing your Provider class, not the custom Provider class itself. +- ``-i {my.custom_provider other.custom_provider}`` list of additional custom + providers to use. Note that is the import path of the package containing + your Provider class, not the custom Provider class itself. - ``fake``: is the name of the fake to generate an output for, such as ``name``, ``address``, or ``text`` -- ``[fake argument ...]``: optional arguments to pass to the fake (e.g. the profile fake takes an optional list of comma separated field names as the first argument) +- ``[fake argument ...]``: optional arguments to pass to the fake (e.g. the + profile fake takes an optional list of comma separated field names as the + first argument) Examples: @@ -326,8 +329,8 @@ How to use with Factory Boy Accessing the `random` instance ------------------------------- -The ``.random`` property on the generator returns the instance of ``random.Random`` -used to generate the values: +The ``.random`` property on the generator returns the instance of +``random.Random`` used to generate the values: .. code:: python @@ -344,9 +347,9 @@ 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, which -seeds the shared random number generator. Calling the same methods with the -same version of faker and seed produces the same results. +data set. For convenience, the generator also provide a ``seed()`` method, +which seeds the shared random number generator. Calling the same methods with +the same version of faker and seed produces the same results. .. code:: python @@ -398,7 +401,8 @@ Please see `CONTRIBUTING`_. License ------- -Faker is released under the MIT License. See the bundled `LICENSE`_ file for details. +Faker is released under the MIT License. See the bundled `LICENSE`_ file +for details. Credits -------