From fc70cf4e6a66f53d9d9ddfed70032da9675c47e9 Mon Sep 17 00:00:00 2001 From: Stefan Tatschner Date: Sat, 6 Jun 2015 14:06:03 +0200 Subject: [PATCH] issues.rst: Use definition lists instead of plain lists --- dev/issues.rst | 56 +++++++++++++++++++++++++++++--------------------- 1 file changed, 33 insertions(+), 23 deletions(-) diff --git a/dev/issues.rst b/dev/issues.rst index edc4c8a3f..24c4c23f1 100644 --- a/dev/issues.rst +++ b/dev/issues.rst @@ -16,39 +16,49 @@ Examples include "Duplicate of #123", "Discovered to be configuration error", "Rendered moot by #123" and so on. We don't use the "invalid" or "wontfix" labels. -- **android** - Marks an issue as occurring on the Android platform - only. +android + Marks an issue as occurring on the Android platform only. -- **bug** - The issue is a verified bug. +bug + The issue is a verified bug. -- **build** - The issue is caused by or requires changes to the build - system (scripts or Docker image). +build + The issue is caused by or requires changes to the build system + (scripts or Docker image). -- **docs** - Something requires documenting. +docs + Something requires documenting. -- **easy** - This could be easily fixed, probably an hour's work or - less. These issues are good starting points for new contributors. +easy + This could be easily fixed, probably an hour's work or less. + These issues are good starting points for new contributors. -- **enhancement** - This is a new feature or an improvement of some - kind, as opposed to a problem (bug). +enhancement + This is a new feature or an improvement of some kind, as + opposed to a problem (bug). -- **help-wanted** - The core team can't or won't do this, but someone - else is welcome to. This does not mean that help is not wanted on the - *other* issues. You can see this as a soft ``wontfix``. (A hard - ``wontfix`` is simply a close with a short explanation why.) +help-wanted + The core team can't or won't do this, but someone else is welcome + to. This does not mean that help is not wanted on the *other* + issues. You can see this as a soft ``wontfix``. (A hard ``wontfix`` + is simply a close with a short explanation why.) -- **pr-bugfix** - This pull request *fixes* a bug. This is different - from the ``bug`` label, as there may also be pull requests with for - example tests that *prove* a bug which would then be labeled ``bug``. +pr-bugfix + This pull request *fixes* a bug. This is different from the ``bug`` + label, as there may also be pull requests with for example tests + that *prove* a bug which would then be labeled ``bug``. -- **pr-refactor** - This pull request is a refactoring, i.e. not - supposed to change behavior. +pr-refactor + This pull request is a refactoring, i.e. not supposed to change + behavior. -- **pr-wait-or-pending** - This pull request is not ready for merging, - even if the tests pass and it looks good. It is incomplete or - requires more discussion. +pr-wait-or-pending + This pull request is not ready for merging, even if the tests + pass and it looks good. It is incomplete or requires more + discussion. -- **protocol** - This requires a change to the protocol. +protocol + This requires a change to the protocol. Milestone ---------