Skip to content

Commit

Permalink
Merge pull request #17 from luizalabs/update-docs
Browse files Browse the repository at this point in the history
Update the project's introduction in docs after the latest features
  • Loading branch information
renanivo committed Oct 2, 2019
2 parents 167d2d9 + 70ca666 commit f010c2e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/index.md
Expand Up @@ -10,12 +10,12 @@ What is a backend?

_Plugable Backend_ (or _backend_ for short) is a term [borrowed from Django](http://charlesleifer.com/blog/django-patterns-pluggable-backends/).
It is a standard interface to a resource, so that it can be _plugged_ at the
your will. In order to instantiate a backend, **Ramos** requires the class to
have a _classmethod_ `create`, which can't accept any parameter and must return
developer's will. In order to instantiate a backend, **Ramos** requires the
class to have a _classmethod_ `create`, which usually does not accept any parameter
([but it can, if you need](mixins.md#ThreadSafeCreateMixin)) and must return
your backend's instance. **Ramos** does not verify if the classes configured
in a backend type really have a common interface, it is up to you
(but you can use [Abstract Base Classes](https://docs.python.org/3/library/abc.html)
for that).
([Abstract Base Classes](https://docs.python.org/3/library/abc.html) can help).


Installation
Expand Down

0 comments on commit f010c2e

Please sign in to comment.