From: Dieter Plaetinck Date: Sun, 31 Oct 2010 08:45:45 +0000 (+0100) Subject: Clarify that bugs cannot contain multi-line descriptions X-Git-Tag: 1.0.0~2 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=66037fb14b06ab42eb37e6cc93d10c9717ce0d9e;p=be.git Clarify that bugs cannot contain multi-line descriptions --- diff --git a/doc/tutorial.txt b/doc/tutorial.txt index 0da1de2..0154f5b 100644 --- a/doc/tutorial.txt +++ b/doc/tutorial.txt @@ -132,10 +132,11 @@ of the ``--reporter`` option to give them credit:: See ``be help new`` for more details. While the bug summary should include the appropriate keywords, it -should also be brief. You should probably add a comment immediately -giving a more elaborate explanation of the problem so that the -developer understands what you want and when the bug can be considered -fixed. +should also be brief. Unlike other bug trackers, the bug itself cannot +contain a multi-line description. So you should probably add a comment +immediately giving a more elaborate explanation of the problem so that +the developer understands what you want and when the bug can be +considered fixed. Commenting on bugs ------------------