Skip to content

Commit f94ecd9

Browse files
committed
re-word Doc Driven Dev section
1 parent 2b21e7a commit f94ecd9

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

elmish.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,9 @@ Let's start with a couple of "_familiar_" _generic_ functions
142142
#### `empty` the DOM
143143

144144
Start by _describing_ what the `empty` function _does_. <br />
145-
This is both to clarify our _own_ understanding as the people _writing_
146-
the code and to _clearly communicate_ with the **`humans` _reading_** the code.
145+
This is both to clarify our _own_ understanding
146+
as the people _writing_ the code <br />
147+
and to _clearly communicate_ with the **`humans` _reading_** the code.
147148

148149
##### Function Description
149150

@@ -161,12 +162,13 @@ with _just_ the function description:
161162
* it is used to erase the DOM before re-rendering the app.
162163
*/
163164
```
164-
Writing out the function documentation _first_ helps you _think_
165-
about what the functionality is.
166-
Even if you know exactly what code needs to be written,
167-
resist the temptation to write the code until it is documented.
168-
Always imagine that you are "_pairing_" with someone
169-
who does _not_ already "know the solution"
165+
Writing out the function documentation _first_
166+
helps us _think_ about the functionality.
167+
Even if you know _exactly_ what code needs to be written,
168+
_resist_ the temptation to write the code until it is documented.
169+
Even if you are writing code alone,
170+
always imagine that you are "_pairing_" with someone
171+
who does _not_ (_already_) "know the solution"
170172
and you are _explaining_ it to them.
171173

172174

0 commit comments

Comments
 (0)