Skip to content

Commit e212014

Browse files
authored
Merge pull request #179 from rocket-3/patch-1
Add a note and some formatting in readme.md/How to format
2 parents 3da17f9 + 0bce5a0 commit e212014

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,9 @@ to the leading space in every consecutive line):
7878
[related code]
7979
```
8080

81-
\[\] - Replace with apropriate data (see text enclosed in brackets)
82-
<> - Omitable (enclosed data can be left out)
81+
`[]` - Replace with apropriate data (see text enclosed in brackets)
82+
83+
`<>` - Omitable (enclosed data can be left out)
8384

8485
Example:
8586

@@ -101,6 +102,9 @@ The specified markers will be included in the issues body
101102
along with some predefined text. If your comment is longer
102103
than 40 characters, it will be truncated in the title.
103104

105+
Note: if you create several puzzle duplicates (same text after puzzle keyword),
106+
pdd will fail to parse puzzles and produce an error with duplicates list.
107+
104108
There are 3 supported keywords, one of which must precede the mandatory
105109
puzzle marker. They are `@todo`, `TODO` and `TODO:`.
106110

0 commit comments

Comments
 (0)