diff options
author | Raphaël Barrois <raphael.barrois@polytechnique.org> | 2019-08-24 14:57:46 +0200 |
---|---|---|
committer | Raphaël Barrois <raphael.barrois@polytechnique.org> | 2019-08-26 21:37:10 +0200 |
commit | 870060605e3955114766a979de1afadbea4dc603 (patch) | |
tree | 87c6a0e3656ad0eb3758f2b14cfceadde689188b /docs | |
parent | 5c1abbef4d86bcd1ec68cf5deb90b559faf25502 (diff) | |
download | semantic-version-870060605e3955114766a979de1afadbea4dc603.tar.gz |
Deprecate support for 'partial' versions.rba/pre-2.8
Their comparison semantics were ill-defined, and mostly an
implementation detail for the old, 'native' specs.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/django.rst | 3 | ||||
-rw-r--r-- | docs/reference.rst | 4 |
2 files changed, 7 insertions, 0 deletions
diff --git a/docs/django.rst b/docs/django.rst index 382b332..34a0fe3 100644 --- a/docs/django.rst +++ b/docs/django.rst @@ -18,6 +18,9 @@ with their :attr:`~django.db.models.CharField.max_length` defaulting to 200. .. attribute:: partial + .. deprecated:: 2.7 + Support for partial versions will be removed in 3.0. + Boolean; whether :attr:`~semantic_version.Version.partial` versions are allowed. .. attribute:: coerce diff --git a/docs/reference.rst b/docs/reference.rst index 3495940..1c4f0cf 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -95,6 +95,10 @@ Representing a version (the Version class) ``bool``, whether this is a 'partial' or a complete version number. Partial version number may lack :attr:`minor` or :attr:`patch` version numbers. + .. deprecated:: 2.7 + The ability to define a partial version will be removed in version 3.0. + Use :class:`SimpleSpec` instead: ``SimpleSpec('1.x.x')``. + .. attribute:: major ``int``, the major version number |