Briq
/
django-polymorphic
6
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation to reflect recent changes

fix_request_path_info
Hugo Osvaldo Barrera 2015-10-21 22:16:35 -03:00
parent c48d4f589b
commit d4f061de8b
3 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/advanced.rst
View File

@ -6,7 +6,7 @@ Advanced features
In the examples below, these models are being used:: In the examples below, these models are being used::
from django.db import models from django.db import models
from polymorphic import PolymorphicModel from polymorphic.models import PolymorphicModel
class ModelA(PolymorphicModel): class ModelA(PolymorphicModel):
field1 = models.CharField(max_length=10) field1 = models.CharField(max_length=10)

14
docs/managers.rst
View File

@ -10,9 +10,10 @@ manager class, just derive your manager from ``PolymorphicManager`` instead of
``models.Manager``. As with vanilla Django, in your model class, you should ``models.Manager``. As with vanilla Django, in your model class, you should
explicitly add the default manager first, and then your custom manager:: explicitly add the default manager first, and then your custom manager::
from polymorphic import PolymorphicModel, PolymorphicManager from polymorphic.models import PolymorphicModel
from polymorphic.manager import PolymorphicManager
class TimeOrderedManager(PolymorphicManager): class TimeOrderedManager(PolymorphicManager):
def get_queryset(self): def get_queryset(self):
qs = super(TimeOrderedManager,self).get_queryset() qs = super(TimeOrderedManager,self).get_queryset()
return qs.order_by('-start_date') # order the queryset return qs.order_by('-start_date') # order the queryset
@ -41,9 +42,10 @@ base models, as long as these are polymorphic. This means that all
managers defined in polymorphic base models continue to work as managers defined in polymorphic base models continue to work as
expected in models inheriting from this base model:: expected in models inheriting from this base model::
from polymorphic import PolymorphicModel, PolymorphicManager from polymorphic.models import PolymorphicModel
from polymorphic.manager import PolymorphicManager
class TimeOrderedManager(PolymorphicManager): class TimeOrderedManager(PolymorphicManager):
def get_queryset(self): def get_queryset(self):
qs = super(TimeOrderedManager,self).get_queryset() qs = super(TimeOrderedManager,self).get_queryset()
return qs.order_by('-start_date') # order the queryset return qs.order_by('-start_date') # order the queryset
@ -77,7 +79,9 @@ which is the queryset class the manager should use. Just as with vanilla Django,
you may define your own custom queryset classes. Just use PolymorphicQuerySet you may define your own custom queryset classes. Just use PolymorphicQuerySet
instead of Django's QuerySet as the base class:: instead of Django's QuerySet as the base class::
from polymorphic import PolymorphicModel, PolymorphicManager, PolymorphicQuerySet from polymorphic.models import PolymorphicModel
from polymorphic.manager import PolymorphicManager
from polymorphic.query import PolymorphicQuerySet
class MyQuerySet(PolymorphicQuerySet): class MyQuerySet(PolymorphicQuerySet):
def my_queryset_method(...): def my_queryset_method(...):

2
docs/quickstart.rst
View File

@ -19,7 +19,7 @@ Making Your Models Polymorphic
Use ``PolymorphicModel`` instead of Django's ``models.Model``, like so:: Use ``PolymorphicModel`` instead of Django's ``models.Model``, like so::
from polymorphic import PolymorphicModel from polymorphic.models import PolymorphicModel
class Project(PolymorphicModel): class Project(PolymorphicModel):
topic = models.CharField(max_length=30) topic = models.CharField(max_length=30)