diff --git a/docs/concepts.rst b/docs/concepts.rst index 0a0ad49..4c78286 100644 --- a/docs/concepts.rst +++ b/docs/concepts.rst @@ -339,6 +339,10 @@ use one you're familiar with from packaging systems like * To be clear, **you may put any combination of major+minor version number in these annotations**, just as with the simpler ``(1.5+)`` style format. + * This is mostly applicable to bugs or backported issues. Features, support + items and major bugs only need to inform Releases about major release + lines. + Armed with this more powerful syntax, we can limit some issues just to the 1.x line:: diff --git a/docs/usage.rst b/docs/usage.rst index aebb5b3..ba36323 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -89,6 +89,12 @@ Specifically: ``(N.N+)`` allowing annotation of issues belonging to specific major versions. + .. note:: + It is possible to give *both* a regular keyword + (``backported``/``major``) *and* a spec (``(N.N+)``/``(>=1.0)``) in + the same issue. However, giving two keywords or two specs at the same + time makes no sense & is not allowed. + * Regular Sphinx content may be given after issue roles and will be preserved as-is when rendering. For example, in ``:bug:`123` Fixed a bug, thanks `@somebody`!``, the rendered changelog will preserve/render "Fixed a bug,