Skip to content

Commit f1ae0e2

Browse files
aero31aerotimabbott
authored andcommitted
docs: Do not indicate that Bugdown is an extension.
Also fix minor typos and formatting.
1 parent 0451c42 commit f1ae0e2

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/subsystems/markdown.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ tests with `tools/test-js-with-node markdown` and backend tests with
8585

8686
First, you will likely find these third-party resources helpful:
8787

88-
* **[Python-Markdown Extensions API](https://pypi.python.org/pypi/Markdown)**
89-
is used by Zulip to make the above listed changes to markdown syntax.
88+
* **[Python-Markdown](https://pypi.python.org/pypi/Markdown)** is the markdown
89+
library used by Zulip as a base to build our custom markdown syntax upon.
9090
* **[Python's XML ElementTree](https://docs.python.org/3/library/xml.etree.elementtree.html)**
9191
is the part of the Python standard library used by Python Markdown
9292
and any custom extensions to generate and modify the output HTML.
@@ -121,7 +121,7 @@ Important considerations for any changes are:
121121
and for that reason we currently should avoid making database
122122
queries inside the markdown processor. This is a technical
123123
implementation detail that could be changed with a few days of work,
124-
but is important detail to know about until we do that work.
124+
but is an important detail to know about until we do that work.
125125
* Testing: Every new feature should have both positive and negative
126126
tests; they're easy to write and give us the flexibility to refactor
127127
frequently.
@@ -172,23 +172,23 @@ mistakes, you don't want to be doing that often. There are basically
172172
2 types of error rates that are important for a product like Zulip:
173173

174174
* What fraction of the time, if you pasted a short technical email
175-
that you wrote to your team and passed it through your Markdown
176-
implementation, would you need to change the text of your email for it
177-
to render in a reasonable way? This is the "accidental Markdown
178-
syntax" problem, common with Markdown syntax like the italics syntax
179-
interacting with talking about `char *`s.
175+
that you wrote to your team and passed it through your Markdown
176+
implementation, would you need to change the text of your email for it
177+
to render in a reasonable way? This is the "accidental Markdown
178+
syntax" problem, common with Markdown syntax like the italics syntax
179+
interacting with talking about `char *`s.
180180

181181
* What fraction of the time do users attempting to use a particular
182-
Markdown syntax actually succeed at doing so correctly? Syntax like
183-
required a blank line between text and the start of a bulleted list
184-
raise this figure substantially.
182+
Markdown syntax actually succeed at doing so correctly? Syntax like
183+
required a blank line between text and the start of a bulleted list
184+
raise this figure substantially.
185185

186186
Both of these are minor issues for most products using Markdown, but
187187
they are major problems in the instant messaging context, because one
188-
can't edit a message that has already been sent and users are
189-
generally writing quickly. Zulip's Markdown strategy is based on the
190-
principles of giving users the power they need to express complicated
191-
ideas in a chat context while minimizing those two error rates.
188+
can't edit a message that has already been sent before others read it
189+
and users are generally writing quickly. Zulip's Markdown strategy is
190+
based on the principles of giving users the power they need to express
191+
complicated ideas in a chat context while minimizing those two error rates.
192192

193193
## Zulip's Changes to Markdown
194194

0 commit comments

Comments
 (0)