From 2f83a39684690ed373ffd327198433a456648504 Mon Sep 17 00:00:00 2001 From: Natalia Pozhidaeva Date: Sat, 20 Jan 2024 22:27:46 -0500 Subject: [PATCH 01/11] [#224] Add description for multiline puzzle and remove unsupported formats --- README.md | 43 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 36 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0d49523..3760ecc 100644 --- a/README.md +++ b/README.md @@ -146,6 +146,10 @@ Example: * @todo #234:15m/DEV This is something to do later * in one of the next releases. I can't figure out * how to implement it now, that's why the puzzle. + * The text can be so long, as needed, just use + * the same anount of spaces, as the second line. + * This text will be not a part of the puzzle, as + * has less spaces. */ void sendEmail() { throw new UnsupportedOperationException(); @@ -172,13 +176,11 @@ as long as you have one of the 3 supported keywords right in front of the mandatory marker): ``` -// @todo #224 -/* @todo #TEST-13 */ -# @todo #55:45min -@todo #67/DES -;; @todo #678:40m/DEV -// TODO: #1:30min -(* TODO #42 *) +// @todo #224 Puzzle description +# @todo #55:45min Puzzle description +@todo #67/DES Puzzle description +;; @todo #678:40m/DEV Puzzle description +// TODO: #1:30min Puzzle description ``` Here `DES` and `DEV` are the roles of people who must fix that puzzles; @@ -192,6 +194,33 @@ us to build a hierarchical dependency tree of all puzzles, like for example. Technically, of course, you can abuse the system and put a dummy `#1` marker everywhere. +### Multiline examples + +```xml + +``` + +```java +/** + * @todo #36 Multiline text can use the same prefix in all lines or the same + * amount of spaces. + So this will be added to the puzzle description. If you want to divide the + * puzzle by empty line, just add a space to that line + * + * and continue the text after. + * + * This line is not part of the puzzle, because the line before contains less + * spaces then the second line. + */ +``` + ## How to Configure Rules? You can specify post-parsing rules for your puzzles, in command line, From 8e26e6f926fe598f321d6a7ae91141a54862f945 Mon Sep 17 00:00:00 2001 From: Natalia Pozhidaeva Date: Mon, 22 Jan 2024 14:07:46 -0500 Subject: [PATCH 02/11] Update README.md Co-authored-by: Slava Semushin --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3760ecc..3dde0f2 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,7 @@ Example: * The text can be so long, as needed, just use * the same anount of spaces, as the second line. * This text will be not a part of the puzzle, as - * has less spaces. + * it has less spaces. */ void sendEmail() { throw new UnsupportedOperationException(); From a2acecfc3ee0a163e6294433ce5a4d75ecb54d27 Mon Sep 17 00:00:00 2001 From: Natalia Pozhidaeva Date: Mon, 22 Jan 2024 14:10:37 -0500 Subject: [PATCH 03/11] Update README.md Co-authored-by: Slava Semushin --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3dde0f2..7407fa3 100644 --- a/README.md +++ b/README.md @@ -200,7 +200,7 @@ and put a dummy `#1` marker everywhere. ``` @@ -182,12 +192,12 @@ and put a dummy `#1` marker everywhere. * @todo #36 Multiline text can use the same prefix in all lines or the same * amount of spaces. * So this will be added to the puzzle description. If you want to divide the - * puzzle by empty line, just add a backspace to that line + * puzzle logically by empty line, just add a backspace to that line * \ * and continue the text after. * - * This line is not part of the puzzle, because the line before contains less - * spaces then the second line. + * This line is not part of the puzzle, because the line before does not contain + * prefix. */ ```