Skip to content

Commit 93dad08

Browse files
committed
Thorough spell check of the docs.
1 parent 9f6b45f commit 93dad08

28 files changed

+441
-429
lines changed

docs/authors.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ Primary Authors
99

1010
[Yuri Takteyev](http://freewisdom.org/)
1111

12-
: Yuri has written much of the current code while procrastingating his Ph.D.
12+
: Yuri has written much of the current code while procrastinating his Ph.D.
1313

1414
[Waylan Limberg](http://achinghead.com/)
1515

1616
: Waylan is the current maintainer of the code and has written much the current
1717
code base, included a complete refactor of the core. He started out by
18-
authoring mmany of the available extensions and later was asked to join Yuri,
19-
where he began fixing nummrious bugs, adding documentation and making general
20-
improvements to the existing codebase.
18+
authoring many of the available extensions and later was asked to join Yuri,
19+
where he began fixing numerous bugs, adding documentation and making general
20+
improvements to the existing code base.
2121

2222
Artem Yunusov
2323

@@ -28,7 +28,7 @@ Artem Yunusov
2828
[Manfed Stienstra](http://www.dwerg.net/)
2929

3030
: Manfed wrote the original version of the script and is responsible for
31-
various parts of the existing codebase.
31+
various parts of the existing code base.
3232

3333
David Wolever
3434

@@ -40,7 +40,7 @@ Other Contributors
4040

4141
The incomplete list of individuals below have provided patches or otherwise
4242
contributed to the project in various ways. We would like to thank everyone
43-
who has contributed to the progect in any way.
43+
who has contributed to the project in any way.
4444

4545
* Eric Abrahamsen
4646
* Jeff Balogh

docs/change_log.txt

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@ prev_url: test_suite.html
44
next_title: Release Notes for v2.6
55
next_url: release-2.6.html
66

7-
Python-Markdown Changelog
7+
Python-Markdown Change Log
88
=========================
99

1010
____________: Released version 2.6 ([Notes](release-2.6.html)).
1111

12-
Nov 19, 2014: Released version 2.5.2 (a bugfix release).
12+
Nov 19, 2014: Released version 2.5.2 (a bug-fix release).
1313

14-
Sept 26, 2014: Released version 2.5.1 (a bugfix release).
14+
Sept 26, 2014: Released version 2.5.1 (a bug-fix release).
1515

1616
Sept 12, 2014: Released version 2.5.0 ([Notes](release-2.5.html)).
1717

1818
Feb 16, 2014: Released version 2.4.0 ([Notes](release-2.4.html)).
1919

20-
Mar 22, 2013: Released version 2.3.1 (a bugfix release).
20+
Mar 22, 2013: Released version 2.3.1 (a bug-fix release).
2121

2222
Mar 14, 2013: Released version 2.3.0 ([Notes](release-2.3.html))
2323

@@ -43,24 +43,24 @@ Feb 2009: Added support for multi-level lists to new Blockprocessors.
4343

4444
Jan 2009: Added HTML 4 output as an option (thanks Eric Abrahamsen)
4545

46-
Nov 2008: Added Definistion List ext. Replaced old core with BlockProcessors.
46+
Nov 2008: Added Definition List ext. Replaced old core with Blockprocessors.
4747
Broken up into multiple files.
4848

4949
Oct 2008: Changed logging behavior to work better with other systems.
50-
Refactored tree tarversing. Added treap implementation, then replaced with
51-
OrderedDEict. Renamed various processors to better reflect what they actually
52-
do. Refactored footnote ext to match php Extra's output.
50+
Refactored tree traversing. Added `treap` implementation, then replaced with
51+
OrderedDict. Renamed various processors to better reflect what they actually
52+
do. Refactored footnote ext to match PHP Extra's output.
5353

54-
Sept 2008: Moved prettifyTree to a Postprocessor, replaced wikilink ext
55-
with wikilinks (note the s) ext (uses bracketed links instead of CamelCase)
54+
Sept 2008: Moved `prettifyTree` to a Postprocessor, replaced WikiLink ext
55+
with WikiLinks (note the s) ext (uses bracketed links instead of CamelCase)
5656
and various bug fixes.
5757

58-
August 18 2008: Reorganized directory structure. Added a 'docs' dir
58+
August 18 2008: Reorganized directory structure. Added a 'docs' directory
5959
and moved all extensions into a 'markdown-extensions' package.
6060
Added additional documentation and a few bug fixes. (v2.0-beta)
6161

6262
August 4 2008: Updated included extensions to ElementTree. Added a
63-
seperate commanline script. (v2.0-alpha)
63+
separate command line script. (v2.0-alpha)
6464

6565
July 2008: Switched from home-grown NanoDOM to ElementTree and
6666
various related bugs (thanks Artem Yunusov).
@@ -69,24 +69,24 @@ June 2008: Fixed issues with nested inline patterns and cleaned
6969
up testing framework (thanks Artem Yunusov).
7070

7171
May 2008: Added a number of additional extensions to the
72-
distribution and other minor changes. Moved repo to git from svn.
72+
distribution and other minor changes. Moved repository to git from svn.
7373

74-
Mar 2008: Refactored extension api to accept either an
74+
Mar 2008: Refactored extension API to accept either an
7575
extension name (as a string) or an instance of an extension
7676
(Thanks David Wolever). Fixed various bugs and added doc strings.
7777

78-
Feb 2008: Various bugfixes mostly regarding extensions.
78+
Feb 2008: Various bug-fixes mostly regarding extensions.
7979

8080
Feb 18, 2008: Version 1.7.
8181

8282
Feb 13, 2008: A little code cleanup and better documentation
83-
and inheritance for pre/post proccessors.
83+
and inheritance for Preprocessors/Postprocessors.
8484

85-
Feb 9, 2008: Doublequotes no longer html escaped and rawhtml
85+
Feb 9, 2008: Double-quotes no longer HTML escaped and raw HTML
8686
honors `<?foo>`, `<@foo>`, and `<%foo>` for those who run markdown on
8787
template syntax.
8888

89-
Dec 12, 2007: Updated docs. Removed encoding arg from Markdown
89+
Dec 12, 2007: Updated docs. Removed encoding argument from Markdown
9090
and markdown as per list discussion. Clean up in prep for 1.7.
9191

9292
Nov 29, 2007: Added support for images inside links. Also fixed
@@ -96,65 +96,65 @@ Nov 19, 2007: `message` now uses python's logging module. Also removed
9696
limit imposed by recursion in `_process_section()`. You can now parse as
9797
long of a document as your memory can handle.
9898

99-
Nov 5, 2007: Moved safe_mode code to a textPostprocessor and added
99+
Nov 5, 2007: Moved `safe_mode` code to a `textPostprocessor` and added
100100
escaping option.
101101

102102
Nov 3, 2007: Fixed convert method to accept empty strings.
103103

104-
Oct 30, 2007: Fixed BOM removal (thanks Malcolm Tredinnick). Fixed
105-
infinite loop in bracket regex for inline links.
104+
Oct 30, 2007: Fixed `BOM` removal (thanks Malcolm Tredinnick). Fixed
105+
infinite loop in bracket regular expression for inline links.
106106

107-
Oct 11, 2007: LineBreaks is now an inlinePattern. Fixed HR in
108-
blockquotes. Refactored _processSection method (see tracker #1793419).
107+
Oct 11, 2007: `LineBreaks` is now an `inlinePattern`. Fixed `HR` in
108+
blockquotes. Refactored `_processSection` method (see tracker #1793419).
109109

110-
Oct 9, 2007: Added textPreprocessor (from 1.6b).
110+
Oct 9, 2007: Added `textPreprocessor` (from 1.6b).
111111

112112
Oct 8, 2008: Fixed Lazy Blockquote. Fixed code block on first line.
113113
Fixed empty inline image link.
114114

115-
Oct 7, 2007: Limit recursion on inlinePatterns. Added a 'safe' tag
116-
to htmlStash.
115+
Oct 7, 2007: Limit recursion on inline patterns. Added a 'safe' tag
116+
to `htmlStash`.
117117

118118
March 18, 2007: Fixed or merged a bunch of minor bugs, including
119119
multi-line comments and markup inside links. (Tracker #s: 1683066,
120120
1671153, 1661751, 1627935, 1544371, 1458139.) -> v. 1.6b
121121

122122
Oct 10, 2006: Fixed a bug that caused some text to be lost after
123-
comments. Added "safe mode" (user's html tags are removed).
123+
comments. Added "safe mode" (user's HTML tags are removed).
124124

125-
Sept 6, 2006: Added exception for PHP tags when handling html blocks.
125+
Sept 6, 2006: Added exception for PHP tags when handling HTML blocks.
126126

127127
August 7, 2006: Incorporated Sergej Chodarev's patch to fix a problem
128-
with ampersand normalization and html blocks.
128+
with ampersand normalization and HTML blocks.
129129

130-
July 10, 2006: Switched to using optparse. Added proper support for
131-
unicode.
130+
July 10, 2006: Switched to using `optparse`. Added proper support for
131+
Unicode.
132132

133133
July 9, 2006: Fixed the `<[email protected]>` problem (Tracker #1501354).
134134

135135
May 18, 2006: Stopped catching unquoted titles in reference links.
136136
Stopped creating blank headers.
137137

138138
May 15, 2006: A bug with lists, recursion on block-level elements,
139-
run-in headers, spaces before headers, unicode input (thanks to Aaron
139+
run-in headers, spaces before headers, Unicode input (thanks to Aaron
140140
Swartz). Sourceforge tracker #s: 1489313, 1489312, 1489311, 1488370,
141141
1485178, 1485176. (v. 1.5)
142142

143143
Mar. 24, 2006: Switched to a not-so-recursive algorithm with
144-
_handleInline. (Version 1.4)
144+
`_handleInline`. (Version 1.4)
145145

146146
Mar. 15, 2006: Replaced some instance variables with class variables
147147
(a patch from Stelios Xanthakis). Chris Clark's new regexps that do
148-
not trigger midword underlining.
148+
not trigger mid-word underlining.
149149

150150
Feb. 28, 2006: Clean-up and command-line handling by Stewart
151151
Midwinter. (Version 1.3)
152152

153153
Feb. 24, 2006: Fixed a bug with the last line of the list appearing
154-
again as a separate paragraph. Incorporated Chris Clark's "mailto"
154+
again as a separate paragraph. Incorporated Chris Clark's "mail-to"
155155
patch. Added support for `<br />` at the end of lines ending in two or
156-
more spaces. Fixed a crashing bug when using ImageReferencePattern.
157-
Added several utility methods to Nanodom. (Version 1.2)
156+
more spaces. Fixed a crashing bug when using `ImageReferencePattern`.
157+
Added several utility methods to `Nanodom`. (Version 1.2)
158158

159159
Jan. 31, 2006: Added `hr` and `hr/` to BLOCK_LEVEL_ELEMENTS and
160160
changed `<hr/>` to `<hr />`. (Thanks to Sergej Chodarev.)
@@ -165,14 +165,14 @@ getting wrapped in `<pre><code>`. (v. 1.1)
165165
Nov. 19, 2005: Made `<!...`, `<?...`, etc. behave like block-level
166166
HTML tags.
167167

168-
Nov. 14, 2005: Added entity code and email autolink fix by Tiago
168+
Nov. 14, 2005: Added entity code and email auto-link fix by Tiago
169169
Cogumbreiro. Fixed some small issues with backticks to get 100%
170170
compliance with John's test suite. (v. 1.0)
171171

172-
Nov. 7, 2005: Added an unlink method for documents to aid with memory
172+
Nov. 7, 2005: Added an `unlink` method for documents to aid with memory
173173
collection (per Doug Sauder's suggestion).
174174

175-
Oct. 29, 2005: Restricted a set of html tags that get treated as
175+
Oct. 29, 2005: Restricted a set of HTML tags that get treated as
176176
block-level elements.
177177

178178
Sept. 18, 2005: Refactored the whole script to make it easier to
@@ -193,8 +193,8 @@ pretty-printing. (v. 0.7)
193193
Aug. 13, 2005: Fixed a number of small bugs in order to conform to the
194194
test suite. (v. 0.6)
195195

196-
Aug. 11, 2005: Added support for inline html and entities, inline
197-
images, autolinks, underscore emphasis. Cleaned up and refactored the
196+
Aug. 11, 2005: Added support for inline HTML and entities, inline
197+
images, auto-links, underscore emphasis. Cleaned up and refactored the
198198
code, added some more comments.
199199

200200
Feb. 19, 2005: Rewrote the handling of high-level elements to allow
@@ -203,7 +203,7 @@ multi-line list items and all sorts of nesting.
203203
Feb. 3, 2005: Reference-style links, single-line lists, backticks,
204204
escape, emphasis in the beginning of the paragraph.
205205

206-
Nov. 2004: Added links, blockquotes, html blocks to Manfred
206+
Nov. 2004: Added links, blockquotes, HTML blocks to Manfred
207207
Stienstra's code
208208

209209
Apr. 2004: Manfred's version at <http://www.dwerg.net/projects/markdown/>

docs/cli.txt

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,18 @@ following format:
2323

2424
$ python -m markdown [options] [args]
2525

26-
That will run the module as a script with the options and args provided.
26+
That will run the module as a script with the options and arguments provided.
2727

2828
At its most basic usage, one would simply pass in a file name as the only argument:
2929

3030
$ python -m markdown input_file.txt
3131

32-
Piping input and output (on STDIN and STDOUT) is fully supported as well.
32+
Piping input and output (on `STDIN` and `STDOUT`) is fully supported as well.
3333
For example:
3434

3535
$ echo "Some **Markdown** text." | python -m markdown > output.html
3636

37-
Use the `--help` option for a list all available options and args:
37+
Use the `--help` option for a list all available options and arguments:
3838

3939
$ python -m markdown --help
4040

@@ -44,53 +44,53 @@ follow the instructions below to use a wrapper script:
4444
Setup
4545
-----
4646

47-
Upon installation, the ``markdown_py`` script will have been copied to
47+
Upon installation, the `markdown_py` script will have been copied to
4848
your Python "Scripts" directory. Different systems require different methods to
4949
ensure that any files in the Python "Scripts" directory are on your system
5050
path.
5151

5252
* **Windows**:
5353

5454
Assuming a default install of Python on Windows, your "Scripts" directory
55-
is most likely something like ``C:\\Python26\Scripts``. Verify the location
55+
is most likely something like `C:\\Python26\Scripts`. Verify the location
5656
of your "Scripts" directory and add it to you system path.
5757

58-
Calling ``markdown_py`` from the command line will call the wrapper batch
59-
file ``markdown_py.bat`` in the "Scripts" directory created during install.
58+
Calling `markdown_py` from the command line will call the wrapper batch
59+
file `markdown_py.bat` in the `"Scripts"` directory created during install.
6060

6161
* __*nix__ (Linux, OSX, BSD, Unix, etc.):
6262

6363
As each *nix distribution is different and we can't possibly document all
6464
of them here, we'll provide a few helpful pointers:
6565

6666
* Some systems will automatically install the script on your path. Try it
67-
and see if it works. Just run ``markdown_py`` from the command line.
67+
and see if it works. Just run `markdown_py` from the command line.
6868

6969
* Other systems may maintain a separate "Scripts" ("bin") directory which
7070
you need to add to your path. Find it (check with your distribution) and
7171
either add it to your path or make a symbolic link to it from your path.
7272

73-
* If you are sure ``markdown_py`` is on your path, but it still isn't being
73+
* If you are sure `markdown_py` is on your path, but it still is not being
7474
found, check the permissions of the file and make sure it is executable.
7575

76-
As an alternative, you could just ``cd`` into the directory which contains
76+
As an alternative, you could just `cd` into the directory which contains
7777
the source distribution, and run it from there. However, remember that your
7878
markdown text files will not likely be in that directory, so it is much
79-
more convenient to have ``markdown_py`` on your path.
79+
more convenient to have `markdown_py` on your path.
8080

8181
!!!Note
82-
Python-Markdown uses "markdown_py" as a script name because
82+
Python-Markdown uses `"markdown_py"` as a script name because
8383
the Perl implementation has already taken the more obvious name "markdown".
8484
Additionally, the default Python configuration on some systems would cause a
85-
script named "markdown.py" to fail by importing itself rather than the markdown
86-
library. Therefore, the script has been named "markdown_py" as a compromise. If
85+
script named `"markdown.py"` to fail by importing itself rather than the markdown
86+
library. Therefore, the script has been named `"markdown_py"` as a compromise. If
8787
you prefer a different name for the script on your system, it is suggested that
8888
you create a symbolic link to `markdown_py` with your preferred name.
8989

9090
Usage
9191
-----
9292

93-
To use ``markdown_py`` from the command line, run it as
93+
To use `markdown_py` from the command line, run it as
9494

9595
$ markdown_py input_file.txt
9696

@@ -133,15 +133,15 @@ above example might look like this:
133133
UNIQUE_IDS: True
134134

135135
Note that while the `--extension_configs` option does specify the "markdown.extensions.footnotes"
136-
extension, you still need to load the extension with the `-x` option, or the configs for that
136+
extension, you still need to load the extension with the `-x` option, or the configuration for that
137137
extension will be ignored.
138138

139-
The `--extension_configs` option will only support YAML config files if [PyYaml] is
139+
The `--extension_configs` option will only support YAML configuration files if [PyYAML] is
140140
installed on your system. JSON should work with no additional dependencies. The format
141-
of your config file is automatically detected.
141+
of your configuration file is automatically detected.
142142

143143
!!!warning
144-
The previously documented method of appending the extension configs as a string to the
144+
The previously documented method of appending the extension configuration options as a string to the
145145
extension name will be deprecated in Python-Markdown version 2.6. The `--extension_configs`
146146
option should be used instead. See the [2.5 release notes] for more information.
147147

docs/extensions/admonition.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Admonitions are created using the following syntax:
2626

2727
This is the second paragraph.
2828

29-
`type` will be used as the CSS classname and as default title. It must be a
29+
`type` will be used as the CSS class name and as default title. It must be a
3030
single word. So, for instance:
3131

3232
!!! note

0 commit comments

Comments
 (0)