From 93dad08ca9967d75e5bb2b2e6e6301a98b900bfd Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Sat, 7 Feb 2015 14:22:47 -0500 Subject: Thorough spell check of the docs. --- docs/authors.txt | 12 +- docs/change_log.txt | 86 ++++---- docs/cli.txt | 38 ++-- docs/extensions/admonition.txt | 2 +- docs/extensions/api.txt | 368 +++++++++++++++++---------------- docs/extensions/attr_list.txt | 2 +- docs/extensions/code_hilite.txt | 24 +-- docs/extensions/extra.txt | 29 ++- docs/extensions/fenced_code_blocks.txt | 6 +- docs/extensions/footnotes.txt | 2 +- docs/extensions/header_id.txt | 11 +- docs/extensions/meta_data.txt | 6 +- docs/extensions/nl2br.txt | 6 +- docs/extensions/smarty.txt | 6 +- docs/extensions/toc.txt | 6 +- docs/extensions/wikilinks.txt | 12 +- docs/install.txt | 4 +- docs/reference.txt | 34 +-- docs/release-2.0.1.txt | 6 +- docs/release-2.0.txt | 2 +- docs/release-2.1.0.txt | 30 +-- docs/release-2.2.0.txt | 4 +- docs/release-2.3.txt | 36 ++-- docs/release-2.4.txt | 10 +- docs/release-2.5.txt | 48 ++--- docs/release-2.6.txt | 42 ++-- docs/siteindex.txt | 12 +- docs/test_suite.txt | 26 +-- 28 files changed, 441 insertions(+), 429 deletions(-) (limited to 'docs') diff --git a/docs/authors.txt b/docs/authors.txt index 53eaaba..84c69d0 100644 --- a/docs/authors.txt +++ b/docs/authors.txt @@ -9,15 +9,15 @@ Primary Authors [Yuri Takteyev](http://freewisdom.org/) -: Yuri has written much of the current code while procrastingating his Ph.D. +: Yuri has written much of the current code while procrastinating his Ph.D. [Waylan Limberg](http://achinghead.com/) : Waylan is the current maintainer of the code and has written much the current code base, included a complete refactor of the core. He started out by - authoring mmany of the available extensions and later was asked to join Yuri, - where he began fixing nummrious bugs, adding documentation and making general - improvements to the existing codebase. + authoring many of the available extensions and later was asked to join Yuri, + where he began fixing numerous bugs, adding documentation and making general + improvements to the existing code base. Artem Yunusov @@ -28,7 +28,7 @@ Artem Yunusov [Manfed Stienstra](http://www.dwerg.net/) : Manfed wrote the original version of the script and is responsible for - various parts of the existing codebase. + various parts of the existing code base. David Wolever @@ -40,7 +40,7 @@ Other Contributors The incomplete list of individuals below have provided patches or otherwise contributed to the project in various ways. We would like to thank everyone -who has contributed to the progect in any way. +who has contributed to the project in any way. * Eric Abrahamsen * Jeff Balogh diff --git a/docs/change_log.txt b/docs/change_log.txt index e63c48a..9eb2ea8 100644 --- a/docs/change_log.txt +++ b/docs/change_log.txt @@ -4,20 +4,20 @@ prev_url: test_suite.html next_title: Release Notes for v2.6 next_url: release-2.6.html -Python-Markdown Changelog +Python-Markdown Change Log ========================= ____________: Released version 2.6 ([Notes](release-2.6.html)). -Nov 19, 2014: Released version 2.5.2 (a bugfix release). +Nov 19, 2014: Released version 2.5.2 (a bug-fix release). -Sept 26, 2014: Released version 2.5.1 (a bugfix release). +Sept 26, 2014: Released version 2.5.1 (a bug-fix release). Sept 12, 2014: Released version 2.5.0 ([Notes](release-2.5.html)). Feb 16, 2014: Released version 2.4.0 ([Notes](release-2.4.html)). -Mar 22, 2013: Released version 2.3.1 (a bugfix release). +Mar 22, 2013: Released version 2.3.1 (a bug-fix release). Mar 14, 2013: Released version 2.3.0 ([Notes](release-2.3.html)) @@ -43,24 +43,24 @@ Feb 2009: Added support for multi-level lists to new Blockprocessors. Jan 2009: Added HTML 4 output as an option (thanks Eric Abrahamsen) -Nov 2008: Added Definistion List ext. Replaced old core with BlockProcessors. +Nov 2008: Added Definition List ext. Replaced old core with Blockprocessors. Broken up into multiple files. Oct 2008: Changed logging behavior to work better with other systems. -Refactored tree tarversing. Added treap implementation, then replaced with -OrderedDEict. Renamed various processors to better reflect what they actually -do. Refactored footnote ext to match php Extra's output. +Refactored tree traversing. Added `treap` implementation, then replaced with +OrderedDict. Renamed various processors to better reflect what they actually +do. Refactored footnote ext to match PHP Extra's output. -Sept 2008: Moved prettifyTree to a Postprocessor, replaced wikilink ext -with wikilinks (note the s) ext (uses bracketed links instead of CamelCase) +Sept 2008: Moved `prettifyTree` to a Postprocessor, replaced WikiLink ext +with WikiLinks (note the s) ext (uses bracketed links instead of CamelCase) and various bug fixes. -August 18 2008: Reorganized directory structure. Added a 'docs' dir +August 18 2008: Reorganized directory structure. Added a 'docs' directory and moved all extensions into a 'markdown-extensions' package. Added additional documentation and a few bug fixes. (v2.0-beta) August 4 2008: Updated included extensions to ElementTree. Added a -seperate commanline script. (v2.0-alpha) +separate command line script. (v2.0-alpha) July 2008: Switched from home-grown NanoDOM to ElementTree and various related bugs (thanks Artem Yunusov). @@ -69,24 +69,24 @@ June 2008: Fixed issues with nested inline patterns and cleaned up testing framework (thanks Artem Yunusov). May 2008: Added a number of additional extensions to the -distribution and other minor changes. Moved repo to git from svn. +distribution and other minor changes. Moved repository to git from svn. -Mar 2008: Refactored extension api to accept either an +Mar 2008: Refactored extension API to accept either an extension name (as a string) or an instance of an extension (Thanks David Wolever). Fixed various bugs and added doc strings. -Feb 2008: Various bugfixes mostly regarding extensions. +Feb 2008: Various bug-fixes mostly regarding extensions. Feb 18, 2008: Version 1.7. Feb 13, 2008: A little code cleanup and better documentation -and inheritance for pre/post proccessors. +and inheritance for Preprocessors/Postprocessors. -Feb 9, 2008: Doublequotes no longer html escaped and rawhtml +Feb 9, 2008: Double-quotes no longer HTML escaped and raw HTML honors ``, `<@foo>`, and `<%foo>` for those who run markdown on template syntax. -Dec 12, 2007: Updated docs. Removed encoding arg from Markdown +Dec 12, 2007: Updated docs. Removed encoding argument from Markdown and markdown as per list discussion. Clean up in prep for 1.7. Nov 29, 2007: Added support for images inside links. Also fixed @@ -96,39 +96,39 @@ Nov 19, 2007: `message` now uses python's logging module. Also removed limit imposed by recursion in `_process_section()`. You can now parse as long of a document as your memory can handle. -Nov 5, 2007: Moved safe_mode code to a textPostprocessor and added +Nov 5, 2007: Moved `safe_mode` code to a `textPostprocessor` and added escaping option. Nov 3, 2007: Fixed convert method to accept empty strings. -Oct 30, 2007: Fixed BOM removal (thanks Malcolm Tredinnick). Fixed -infinite loop in bracket regex for inline links. +Oct 30, 2007: Fixed `BOM` removal (thanks Malcolm Tredinnick). Fixed +infinite loop in bracket regular expression for inline links. -Oct 11, 2007: LineBreaks is now an inlinePattern. Fixed HR in -blockquotes. Refactored _processSection method (see tracker #1793419). +Oct 11, 2007: `LineBreaks` is now an `inlinePattern`. Fixed `HR` in +blockquotes. Refactored `_processSection` method (see tracker #1793419). -Oct 9, 2007: Added textPreprocessor (from 1.6b). +Oct 9, 2007: Added `textPreprocessor` (from 1.6b). Oct 8, 2008: Fixed Lazy Blockquote. Fixed code block on first line. Fixed empty inline image link. -Oct 7, 2007: Limit recursion on inlinePatterns. Added a 'safe' tag -to htmlStash. +Oct 7, 2007: Limit recursion on inline patterns. Added a 'safe' tag +to `htmlStash`. March 18, 2007: Fixed or merged a bunch of minor bugs, including multi-line comments and markup inside links. (Tracker #s: 1683066, 1671153, 1661751, 1627935, 1544371, 1458139.) -> v. 1.6b Oct 10, 2006: Fixed a bug that caused some text to be lost after -comments. Added "safe mode" (user's html tags are removed). +comments. Added "safe mode" (user's HTML tags are removed). -Sept 6, 2006: Added exception for PHP tags when handling html blocks. +Sept 6, 2006: Added exception for PHP tags when handling HTML blocks. August 7, 2006: Incorporated Sergej Chodarev's patch to fix a problem -with ampersand normalization and html blocks. +with ampersand normalization and HTML blocks. -July 10, 2006: Switched to using optparse. Added proper support for -unicode. +July 10, 2006: Switched to using `optparse`. Added proper support for +Unicode. July 9, 2006: Fixed the `