Skip to content

Commit

Permalink
Format README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
fcurella committed Jan 14, 2020
1 parent 24401dc commit 1102faf
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
-------
Expand Down

0 comments on commit 1102faf

Please sign in to comment.