Skip to content

Commit 31dd68a

Browse files
committed
#244: Refactor README formatting for clarity and consistency.
1 parent 27c4d45 commit 31dd68a

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/1792d42f96fb45448e8d495ebc4348aa)](https://www.codacy.com/gh/cqfn/pdd/dashboard?utm_source=github.com&utm_medium=referral&utm_content=cqfn/pdd&utm_campaign=Badge_Grade)
1616

1717
Read this article about [_Puzzle Driven Development_][blog].
18-
Check also patent application [US 12/840,306][patent].
18+
Also, check the patent application [US 12/840,306][patent].
1919

2020
Also, check [0pdd.com](https://www.0pdd.com): a hosted service,
2121
where this command line tool works for you.
@@ -38,7 +38,7 @@ pdd --help
3838

3939
## Usage
4040

41-
You can exclude & include certain number of files from the search
41+
You can exclude & include a certain number of files from the search
4242
via these options:
4343

4444
```bash
@@ -47,7 +47,7 @@ pdd --exclude glob
4747

4848
You can skip any file(s) with a name suffix that matches the pattern glob,
4949
using wildcard matching; a name suffix is either the whole
50-
path and name, or reg expr, for example:
50+
path and name, or a regex, for example:
5151

5252
```bash
5353
pdd --exclude src/**/*.java --exclude target/**/*
@@ -155,10 +155,10 @@ and put a dummy `#1` marker everywhere.
155155

156156
For multiline puzzles there are two important things:
157157

158-
- **prefix** - any optional text followed by space before puzzle keyword (todo).
159-
It should be the same for all lines of puzzle description.
160-
- \ symbol can be used to logically divide puzzle description.
161-
prefix should be presented with it.
158+
- **prefix** - any optional text followed by a space before puzzle keyword (todo).
159+
It should be the same for all lines of the puzzle description.
160+
- The `\` symbol can be used to logically divide the puzzle description.
161+
The prefix should be present with it.
162162

163163
Examples:
164164

@@ -170,7 +170,7 @@ Examples:
170170
~ But do not forget about the space before puzzle keyword.
171171
~
172172
~ @todo #34 Description can be as long as needed.
173-
~ Just use at least the same amount of the spaces, as on the first line.
173+
~ Just use at least the same amount of spaces as on the first line.
174174
~ It will be added to description.
175175
-->
176176
```
@@ -180,7 +180,7 @@ Examples:
180180
* @todo #36 Multiline text can use the same prefix in all lines or the same
181181
* amount of spaces.
182182
* So this will be added to the puzzle description. If you want to divide the
183-
* puzzle logically by empty line, just add a backspace to that line
183+
* puzzle logically by an empty line, just add a backslash to that line
184184
* \
185185
* and continue the text after.
186186
*

bin/pdd

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ begin
6060

6161
if opts.help?
6262
puts opts
63-
puts "This is our README to learn more: \
64-
https://github.com/cqfn/pdd/blob/master/README.md"
63+
puts "This is our README to learn more: https://github.com/cqfn/pdd/blob/master/README.md"
6564
exit
6665
end
6766

0 commit comments

Comments
 (0)