diff options
Diffstat (limited to 'docs/django.rst')
| -rw-r--r-- | docs/django.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/django.rst b/docs/django.rst index a43c3ed..ab98e67 100644 --- a/docs/django.rst +++ b/docs/django.rst @@ -6,7 +6,7 @@ Interaction with Django The ``python-semanticversion`` package provides two custom fields for Django: - :class:`VersionField`: stores a :class:`semantic_version.Version` object -- :class:`SpecField`: stores a :class:`semantic_version.Spec` object +- :class:`SpecField`: stores a :class:`semantic_version.BaseSpec` object Those fields are :class:`django.db.models.CharField` subclasses, with their :attr:`~django.db.models.CharField.max_length` defaulting to 200. @@ -28,4 +28,10 @@ with their :attr:`~django.db.models.CharField.max_length` defaulting to 200. .. class:: SpecField - Stores a :class:`semantic_version.Spec` as its comma-separated string representation. + Stores a :class:`semantic_version.BaseSpec` as its textual representation. + + .. attribute:: syntax + + The syntax to use for the field; defaults to ``'native'``. + + .. versionaddedd:: 2.7 |