Skip to content

Commit e302ffc

Browse files
committed
too much escaping in markdown conversion
1 parent ab47761 commit e302ffc

File tree

1 file changed

+22
-26
lines changed

1 file changed

+22
-26
lines changed

README.md

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ data in a string:
2020
'1\n2\n3\n7\n11\n13\n17\n19\n23\n31...
2121
```
2222

23-
If you\'d just like to print or keep your own raw input files, there\'s
23+
If you'd just like to print or keep your own raw input files, there's
2424
a script for that:
2525

2626
``` bash
@@ -85,18 +85,17 @@ export AOC_SESSION=cafef00db01dfaceba5eba11deadbeef
8585
*Note:* Windows users should use `set` instead of `export` here.
8686

8787
The session ID is a cookie which is set when you login to AoC. You can
88-
find it with your browser inspector. If you\'re hacking on AoC at all
88+
find it with your browser inspector. If you're hacking on AoC at all
8989
you probably already know these kind of tricks, but if you need help
90-
with that part then you can [look
91-
here](https://github.com/wimglenn/advent-of-code/issues/1).
90+
with that part then you can [look here](https://github.com/wimglenn/advent-of-code/issues/1).
9291

93-
*Note:* If you don\'t like the env var, you could also keep your
92+
*Note:* If you don't like the env var, you could also keep your
9493
token(s) in files. By default the location is `~/.config/aocd/token`.
9594
Set the `AOCD_DIR` environment variable to some existing directory if
9695
you wish to use another location to store token(s).
9796

98-
*New in version 0.9.0.* There\'s a utility script `aocd-token` which
99-
attempts to find session tokens from your browser\'s cookie storage.
97+
*New in version 0.9.0.* There's a utility script `aocd-token` which
98+
attempts to find session tokens from your browser's cookie storage.
10099
This feature is experimental and requires you to additionally install
101100
the package `browser-cookie3`. Only Chrome, Firefox, and Edge browsers
102101
are currently supported. On macOS, you may get an authentication dialog
@@ -121,7 +120,7 @@ submit(my_answer, part="a", day=25, year=2017)
121120
```
122121

123122
Note that the same filename introspection of year/day also works for
124-
automated submission. There\'s also introspection of the \"level\", i.e.
123+
automated submission. There's also introspection of the "level", i.e.
125124
part a or part b, aocd can automatically determine if you have already
126125
completed part a or not and submit your answer for the correct part
127126
accordingly. In this case, just use:
@@ -135,14 +134,14 @@ The response message from AoC will be printed in the terminal. If you
135134
gave the right answer, then the puzzle will be refreshed in your web
136135
browser (so you can read the instructions for the next part, for
137136
example). **Proceed with caution!** If you submit wrong guesses, your
138-
user **WILL** get rate-limited by Eric, so don\'t call submit until
139-
you\'re fairly confident you have a correct answer!
137+
user **WILL** get rate-limited by Eric, so don't call submit until
138+
you're fairly confident you have a correct answer!
140139

141140
*New in version 2.0.0*: Prevent submission of an answer when it is
142141
certain the value is incorrect. For example, if the server previously
143-
told you that your answer \"1234\" was too high, then aocd will remember
142+
told you that your answer "1234" was too high, then aocd will remember
144143
this info and prevent you from subsequently submitting an even higher
145-
value such as \"1300\".
144+
value such as "1300".
146145

147146
## Models
148147

@@ -180,11 +179,8 @@ Your own solutions can be executed by writing and using an
180179
[entry-point](https://packaging.python.org/specifications/entry-points/)
181180
into your code, registered in the group `"adventofcode.user"`. Your
182181
entry-point should resolve to a callable, and it will be called with
183-
three keyword arguments: `year`, `day`, and `data`. For example, [my
184-
entry-point is called
185-
\"wim\"](https://github.com/wimglenn/advent-of-code-wim/blob/d033366c16fba50e413f2fa7df32e8a0eac9542f/setup.py#L36)
186-
and running against [my
187-
code](https://github.com/wimglenn/advent-of-code-wim/blob/main/aoc_wim/__init__.py)
182+
three keyword arguments: `year`, `day`, and `data`. For example, [my entry-point is called "wim"](https://github.com/wimglenn/advent-of-code-wim/blob/d033366c16fba50e413f2fa7df32e8a0eac9542f/setup.py#L36)
183+
and running against [my code](https://github.com/wimglenn/advent-of-code-wim/blob/main/aoc_wim/__init__.py)
188184
(after `pip install advent-of-code-wim`) would be like this:
189185

190186
``` python
@@ -193,16 +189,16 @@ code](https://github.com/wimglenn/advent-of-code-wim/blob/main/aoc_wim/__init__.
193189
('XLZAKBGZ', '10656')
194190
```
195191

196-
If you\'ve never written a plugin before, see
192+
If you've never written a plugin before, see
197193
<https://entrypoints.readthedocs.io/> for more info about plugin systems
198194
based on Python entry-points.
199195

200196
## Verify your code against multiple inputs
201197

202198
*New in version 0.8.0.*
203199

204-
Ever tried running your code against other people\'s inputs? AoC is full
205-
of tricky edge cases. You may find that sometimes you\'re only getting
200+
Ever tried running your code against other people's inputs? AoC is full
201+
of tricky edge cases. You may find that sometimes you're only getting
206202
the right answer by luck, and your code will fail on some other dataset.
207203
Using aocd, you can collect a few different auth tokens for each of your
208204
accounts (github/google/reddit/twitter) and verify your answers across
@@ -219,7 +215,7 @@ the `aoc` console script:
219215
As you can see above, I actually had incorrect code for [2017 Day 20:
220216
Particle Swarm](https://adventofcode.com/2017/day/20), but that
221217
[bug](https://github.com/wimglenn/advent-of-code-wim/commit/31e454270001c6d06b46014fe5dafd03e29507b8)
222-
only showed up for the google token\'s dataset. Whoops. Also, it looks
218+
only showed up for the google token's dataset. Whoops. Also, it looks
223219
like my algorithm for [2017 Day 13: Packet
224220
Scanners](https://adventofcode.com/2017/day/13) was kinda garbage. Too
225221
slow. According to [AoC FAQ](https://adventofcode.com/about):
@@ -232,7 +228,7 @@ By the way, the `aoc` runner will kill your code if it takes more than
232228
option, e.g. `--timeout=120`.
233229

234230
*New in version 1.1.0:* Added option `--quiet` to suppress any output
235-
from plugins so it doesn\'t mess up the `aoc` runner\'s display.
231+
from plugins so it doesn't mess up the `aoc` runner's display.
236232

237233
*New in version 2.0.0:* You can verify your code against the example
238234
input data and answers, scraped from puzzle pages where available, using
@@ -241,7 +237,7 @@ instead of passing the full user input data.
241237

242238
## How does this library work?
243239

244-
It will automatically get today\'s data at import time, if used within
240+
It will automatically get today's data at import time, if used within
245241
the interactive interpreter. Otherwise, the date is found by
246242
introspection of the path and file name from which `aocd` module was
247243
imported.
@@ -256,8 +252,8 @@ xmas_problem_2016_25b_dawg.py
256252
~/src/aoc/2015/p8.py
257253
```
258254

259-
A filename like `problem_one.py` will not work, so don\'t do that. If
260-
you don\'t like weird frame hacks, just use the `aocd.get_data()`
255+
A filename like `problem_one.py` will not work, so don't do that. If
256+
you don't like weird frame hacks, just use the `aocd.get_data()`
261257
function instead and have a nice day!
262258

263259
## Cache invalidation?
@@ -266,7 +262,7 @@ function instead and have a nice day!
266262
avoid hitting the AoC servers any more often than strictly necessary
267263
(this also speeds things up). All data is persisted in plain text files
268264
under `~/.config/aocd`. To remove any caches, you may simply delete
269-
whatever files you want under that directory tree. If you\'d prefer to
265+
whatever files you want under that directory tree. If you'd prefer to
270266
use a different path, then export an `AOCD_DIR` environment variable
271267
with the desired location.
272268

0 commit comments

Comments
 (0)