From a79ea1790c89d9669851e5210f63f2d7e3e87c10 Mon Sep 17 00:00:00 2001 From: Roman Mogylatov Date: Sun, 18 Dec 2022 21:42:55 -0500 Subject: [PATCH] Update custom provider docs formatting --- docs/main/changelog.rst | 1 + docs/providers/custom.rst | 7 ++++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/main/changelog.rst b/docs/main/changelog.rst index eb6214ac..c940687a 100644 --- a/docs/main/changelog.rst +++ b/docs/main/changelog.rst @@ -15,6 +15,7 @@ Development version and ``actions/download-artifact@v3``. - Fix install crash on non-utf8 systems `#644 `_. - Update FastAPI Redis example to use ``aioredis`` version 2 `#613 `_. +- Update documentation on creating custom providers `#598 `_. - Regenerate C sources using Cython 0.29.32. 4.40.0 diff --git a/docs/providers/custom.rst b/docs/providers/custom.rst index a8ba5652..7c6e475a 100644 --- a/docs/providers/custom.rst +++ b/docs/providers/custom.rst @@ -17,9 +17,10 @@ To create a custom provider you need to follow these rules: 2. You need to implement the ``Provider._provide()`` method. 3. You need to implement the ``Provider.__deepcopy__()`` method. It should return an equivalent copy of a provider. All providers must be copied with the ``deepcopy()`` function - from the ``providers`` module. It's essential to pass ``memo`` into ``deepcopy`` in order to keep the preconfigured ``args`` and ``kwargs`` of stored providers. After the a new provider object is created, use - ``Provider._copy_overriding()`` method to copy all overriding providers. See the example - below. + from the ``providers`` module. It's essential to pass ``memo`` into ``deepcopy`` in order to keep + the preconfigured ``args`` and ``kwargs`` of stored providers. After the a new provider object + is created, use ``Provider._copy_overriding()`` method to copy all overriding providers. See the + example below. 4. If new provider has a ``__init__()`` method, it should call the parent ``Provider.__init__()``. 5. If new provider stores any other providers, these providers should be listed in