Skip to content

Commit 381c5e6

Browse files
committed
anonymize examples in the readme
1 parent e6300f2 commit 381c5e6

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,11 @@ For example, if a file contained these lines somewhere in it:
8686

8787
```
8888
// NOTE: This is the sample output for a note!
89-
// OPTIMIZE (John Postlethwait): This is the sample output for an optimize with an author!
89+
// OPTIMIZE (Mr Author): This is the sample output for an optimize with an author!
9090
// TODO: This is the sample output for a todo!
9191
// HACK: This is the sample output for a hack! Don't commit hacks!
9292
// XXX: This is the sample output for a XXX! XXX's need attention too!
93-
// FIXME (John Postlethwait): This is the sample output for a fixme! Seriously fix this...
93+
// FIXME (Mr Author): This is the sample output for a fixme! Seriously fix this...
9494
// BUG: This is the sample output for a bug! Who checked in a bug?!
9595
```
9696

@@ -100,7 +100,7 @@ Those comments would be annotated as:
100100
• path/to/your/directory/file.js [7 messages]:
101101
[Line 1] ✐ NOTE: This is here because sometimes an intermittent issue appears.
102102
[Line 7] ↻ OPTIMIZE: This could be reworked to not do a O(N2) lookup.
103-
[Line 9] ✓ TODO from John: Add a check here to ensure these are always strings.
103+
[Line 9] ✓ TODO from Mr Author: Add a check here to ensure these are always strings.
104104
[Line 24] ✄ HACK: I am doing something here that is horrible, but it works for now...
105105
[Line 89] ✗ XXX: Let's do this better next time? It's bad.
106106
[Line 136] ☠ FIXME: We sometimes get an undefined index in this array.
@@ -167,9 +167,9 @@ A code annotation needs to follow these rules to be picked up by Fixme:
167167
You can have an author of a comment displayed via Fixme:
168168

169169
```javascript
170-
// NOTE(John Postlethwait): This comment will be shown as a note, and have an author!
170+
// NOTE(Mr Author): This comment will be shown as a note, and have an author!
171171
```
172172

173173
```shell
174-
[Line 1] ✐ NOTE from John Postlethwait: This comment will be shown as a note, and have an author!
174+
[Line 1] ✐ NOTE from Mr Author: This comment will be shown as a note, and have an author!
175175
```

0 commit comments

Comments
 (0)