From 494e80504da660eeecb64b8e338f2503e9e3781c Mon Sep 17 00:00:00 2001 From: smithandrewl Date: Sat, 18 Jan 2014 21:27:08 -0600 Subject: [PATCH 1/9] Updated capitalization in admin.rst Updated capitalization of fabric and salt to Fabric and Salt --- docs/scenarios/admin.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/scenarios/admin.rst b/docs/scenarios/admin.rst index 7f20dcd..84c98da 100644 --- a/docs/scenarios/admin.rst +++ b/docs/scenarios/admin.rst @@ -6,7 +6,7 @@ Fabric `Fabric `_ is a library for simplifying system administration tasks. While Chef and Puppet tend to focus on managing servers -and system libraries, fabric is more focused on application level tasks such +and system libraries, Fabric is more focused on application level tasks such as deployment. Install Fabric: @@ -77,7 +77,7 @@ It supports remote command execution from a central point (master host) to multi hosts (minions). It also supports system states which can be used to configure multiple servers using simple template files. -Salt supports python versions 2.6 and 2.7 and can be installed via pip: +Salt supports Python versions 2.6 and 2.7 and can be installed via pip: .. code-block:: console @@ -95,7 +95,7 @@ The following command lists all available minion hosts, using the ping module. The host filtering is accomplished by matching the minion id, or using the grains system. The `grains `_ system uses static host information like the operating system version or the CPU architecture to -provide a host taxonomy for the salt modules. +provide a host taxonomy for the Salt modules. The following command lists all available minions running CentOS using the grains system: @@ -119,7 +119,7 @@ and start the Apache server: - require: - pkg: apache -State files can be written using YAML, the Jinja2 template system or pure python. +State files can be written using YAML, the Jinja2 template system or pure Python. `Salt Documentation `_ From afa61148f0215f445a831b6a8ade1dfc84d015dd Mon Sep 17 00:00:00 2001 From: smithandrewl Date: Sat, 18 Jan 2014 21:31:10 -0600 Subject: [PATCH 2/9] Hyphenation in ci.rst Replaced frontend with front-end --- docs/scenarios/ci.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst index 6e2025d..5a36bfb 100644 --- a/docs/scenarios/ci.rst +++ b/docs/scenarios/ci.rst @@ -47,7 +47,7 @@ which provides the following features: interpreters * Running tests in each of the environments, configuring your test tool of choice -* Acting as a frontend to Continuous Integration servers, reducing boilerplate +* Acting as a front-end to Continuous Integration servers, reducing boilerplate and merging CI and shell-based testing. From 3918f6b62aec0c75772246baa419056b8961dcfa Mon Sep 17 00:00:00 2001 From: smithandrewl Date: Sat, 18 Jan 2014 21:41:34 -0600 Subject: [PATCH 3/9] Spelling and capitalization in scientific.rst Changed python to Python and corrected some spelling --- docs/scenarios/scientific.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/scenarios/scientific.rst b/docs/scenarios/scientific.rst index a95f986..0d45807 100644 --- a/docs/scenarios/scientific.rst +++ b/docs/scenarios/scientific.rst @@ -9,7 +9,7 @@ Python is frequently used for high-performance scientific applications. Python is widely used in academia and scientific projects because it is easy to write, and it performs really well. -Due to its high performance nature, scientific computing in python often refers +Due to its high performance nature, scientific computing in Python often refers to external libraries, typically written in faster languages (like C, or FORTRAN for matrix operations). The main libraries used are `NumPy`_, `SciPy`_ and `Matplotlib`_. Going into detail about these libraries is beyond the scope @@ -24,11 +24,11 @@ Tools IPython ------- -`IPytthon `_ is an enhanced version of Python interpreter. +`IPython `_ is an enhanced version of Python interpreter. The features it provides are of great interest for the scientists. The `inline mode` allow graphics and plots to be displayed in the terminal (Qt based version). Moreover the `notebook` mode supports literate programming and reproducible science -generating a web-based python notebook. This notebook allowing to store chunk of +generating a web-based Python notebook. This notebook allowing to store chunk of Python code along side to the results and additional comments (HTML, LaTeX, Markdown). The notebook could be shared and exported in various file formats. @@ -64,7 +64,7 @@ SciPy `SciPy `_ is a library that uses Numpy for more mathematical functions. SciPy uses NumPy arrays as the basic data structure. SciPy comes -with modules for various commonly used tasks in scientific programing, for +with modules for various commonly used tasks in scientific programming, for example: linear algebra, integration (calculus), ordinary differential equation solvers and signal processing. @@ -86,7 +86,7 @@ based on Numpy and which provides many useful functions for accessing, indexing, merging and grouping data easily. The main data structure (DataFrame) is close to what could be found in the R statistical package, that is an heterogeneous data tables with name indexing, time series operations -and auto-alignement of data. +and auto-alignment of data. Rpy2 ---- @@ -120,7 +120,7 @@ Many people who do scientific computing are on Windows. And yet many of the scientific computing packages are notoriously difficult to build and install. `Christoph Gohlke `_ however, has compiled a list of Windows binaries for many useful Python packages. The list -of packages has grown from a mainly scientific python resource to a more +of packages has grown from a mainly scientific Python resource to a more general list. It might be a good idea to check it out if you're on Windows. Enthought Python Distribution (EPD) From 1f61583f10c421720ce14195b5f433fbcd069f3f Mon Sep 17 00:00:00 2001 From: smithandrewl Date: Sat, 18 Jan 2014 21:47:45 -0600 Subject: [PATCH 4/9] Capitalization in xml.rst replaced: * xml to XML * python to Python * json to JSON --- docs/scenarios/xml.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/scenarios/xml.rst b/docs/scenarios/xml.rst index 1f8db9c..ee97e2d 100644 --- a/docs/scenarios/xml.rst +++ b/docs/scenarios/xml.rst @@ -8,7 +8,7 @@ untangle an XML document and returns a Python object which mirrors the nodes and attributes in its structure. -For example, an xml file like this: +For example, an XML file like this: .. code-block:: xml @@ -36,9 +36,9 @@ xmltodict --------- `xmltodict `_ is another simple -library that aims at making xml feel like working with json. +library that aims at making XML feel like working with JSON. -An xml file like this: +An XML file like this: .. code-block:: xml @@ -52,7 +52,7 @@ An xml file like this: -can be loaded into a python dict like this: +can be loaded into a Python dict like this: .. code-block:: python @@ -68,6 +68,6 @@ and then you can access elements, attributes and values like this: doc['mydocument']['plus']['@a'] # == u'complex' doc['mydocument']['plus']['#text'] # == u'element as well' -xmltodict also lets you roundtrip back to xml with the unparse function, +xmltodict also lets you roundtrip back to XML with the unparse function, has a streaming mode suitable for handling files that don't fit in memory and supports namespaces. From 065f69d219d3b34e3d2e6648dc54f27ee99e6bee Mon Sep 17 00:00:00 2001 From: smithandrewl Date: Sat, 18 Jan 2014 21:51:42 -0600 Subject: [PATCH 5/9] Capitalization in packaging.rst Replaced python with Python --- docs/shipping/packaging.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst index 100ae91..54d72b0 100644 --- a/docs/shipping/packaging.rst +++ b/docs/shipping/packaging.rst @@ -46,7 +46,7 @@ Go to your command prompt and type: $ python -m SimpleHTTPServer 9000 This runs a simple http server running on port 9000 and will list all packages -(like **MyPackage**). Now you can install **MyPackage** using any python +(like **MyPackage**). Now you can install **MyPackage** using any Python package installer. Using Pip, you would do it like: .. code-block:: console From 5444d703d5253688e93f3f54fdfbd72fa7106d0b Mon Sep 17 00:00:00 2001 From: smithandrewl Date: Sat, 18 Jan 2014 21:58:43 -0600 Subject: [PATCH 6/9] Capitalization in env.rst Replaced python with Python --- docs/dev/env.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dev/env.rst b/docs/dev/env.rst index 7097ee5..e2e628c 100644 --- a/docs/dev/env.rst +++ b/docs/dev/env.rst @@ -64,7 +64,7 @@ to do that which also shows status and warning messages in the statusbar would b Python-mode ^^^^^^^^^^^ -Python-mode_ is a complex solution in VIM for working with python code. +Python-mode_ is a complex solution in VIM for working with Python code. It has: - Asynchronous Python code checking (pylint, pyflakes, pep8, mccabe) in any combination @@ -94,7 +94,7 @@ Emacs is a powerful text editor. It's fully programmable (lisp), but it can be some work to wire up correctly. A good start if you're already an Emacs user is `Python Programming in Emacs`_ at EmacsWiki. -1. Emacs itself comes with a python mode. +1. Emacs itself comes with a Python mode. 2. Python ships with an alternate version: `python-mode.el `_ 3. Fabián Ezequiel Gallina's `python.el `_ From f828b185d9cd4079e9297d3ca193f998a8a8918f Mon Sep 17 00:00:00 2001 From: smithandrewl Date: Sat, 18 Jan 2014 22:12:07 -0600 Subject: [PATCH 7/9] Update learning.rst Changed choosen to chosen Replaced python with Python --- docs/intro/learning.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst index c3c0a22..b7633f9 100644 --- a/docs/intro/learning.rst +++ b/docs/intro/learning.rst @@ -7,9 +7,9 @@ Beginner Learn Python Interactive Tutorial ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Learnpython.org is an easy non-intimidating way to get introduced to python. +Learnpython.org is an easy non-intimidating way to get introduced to Python. The website takes the same approach used on the popular `Try Ruby `_ -website, it has an interactive python interpreter built into the site that +website, it has an interactive Python interpreter built into the site that allows you to go through the lessons without having to install Python locally. `Learn Python `_ @@ -52,11 +52,11 @@ Think Python: How to Think Like a Computer Scientist ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Think Python attempts to give an introduction to basic concepts in computer -science through the use of the python language. The focus was to create a book +science through the use of the Python language. The focus was to create a book with plenty of exercises, minimal jargon and a section in each chapter devoted to the subject of debugging. -While exploring the various features available in the python language the +While exploring the various features available in the Python language the author weaves in various design patterns and best practices. The book also includes several case studies which have the reader explore the @@ -72,11 +72,11 @@ Python Koans Python Koans is a port of Edgecase's Ruby Koans. It uses a test-driven approach, q.v. TEST DRIVEN DESIGN SECTION to provide an interactive tutorial -teaching basic python concepts. By fixing assertion statements that fail in a -test script, this provides sequential steps to learning python. +teaching basic Python concepts. By fixing assertion statements that fail in a +test script, this provides sequential steps to learning Python. For those used to languages and figuring out puzzles on their own, this can be -a fun, attractive option. For those new to python and programming, having an +a fun, attractive option. For those new to Python and programming, having an additional resource or reference will be helpful. `Python Koans `_ @@ -88,7 +88,7 @@ More information about test driven development can be found at these resources: A Byte of Python ~~~~~~~~~~~~~~~~ -A free introductory book that teaches python at the beginner level, it assumes no +A free introductory book that teaches Python at the beginner level, it assumes no previous programming experience. `A Byte of Python for Python 2.x `_ @@ -137,8 +137,8 @@ A Primer on Scientific Programming with Python ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ A Primer on Scientific Programming with Python, written by Hans Petter Langtangen, -mainly covers python's usage in scientific field. In the book, examples are -choosen from mathematics and the natural sciences. +mainly covers Python's usage in scientific field. In the book, examples are +chosen from mathematics and the natural sciences. `A Primer on Scientific Programming with Python `_ @@ -146,7 +146,7 @@ Numerical Methods in Engineering with Python ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Numerical Methods in Engineering with Python,written by Jaan Kiusalaas, attempts to -emphasis on numerical methods and how to implement them in python. +emphasis on numerical methods and how to implement them in Python. `Numerical Methods in Engineering with Python `_ @@ -157,7 +157,7 @@ Python in a Nutshell ~~~~~~~~~~~~~~~~~~~~ Python in a Nutshell, written by Alex Martelli, covers most cross-platform -python's usage, from its syntax to built-in libraries to advanced topics such +Python's usage, from its syntax to built-in libraries to advanced topics such as writing C extensions. `Python in a Nutshell `_ From 74b6d1d61273748e2c8e49f57b86b0099fd0e97d Mon Sep 17 00:00:00 2001 From: smithandrewl Date: Sat, 18 Jan 2014 22:15:30 -0600 Subject: [PATCH 8/9] Replaced "python" with "Python" --- docs/intro/news.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/intro/news.rst b/docs/intro/news.rst index ec829f4..433f907 100644 --- a/docs/intro/news.rst +++ b/docs/intro/news.rst @@ -19,7 +19,7 @@ Python-related news. Pycoder's Weekly ~~~~~~~~~~~~~~~~ -Pycoder's Weekly is a free weekly python newsletter for Python developers +Pycoder's Weekly is a free weekly Python newsletter for Python developers by Python developers (Project, Articles, News, and Jobs). `Pycoder's Weekly `_ From cdd31908faf4ea8383339ec66cb638c8a370afe2 Mon Sep 17 00:00:00 2001 From: smithandrewl Date: Sat, 18 Jan 2014 22:27:06 -0600 Subject: [PATCH 9/9] Capitalization changes in web.rst Replaced: * python with Python * javascript with JavaScript --- docs/scenarios/web.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst index 4574096..d2178f1 100644 --- a/docs/scenarios/web.rst +++ b/docs/scenarios/web.rst @@ -271,10 +271,10 @@ and to the templates themselves. templates. This convenience can lead to uncontrolled increase in complexity, and often harder to find bugs. -- It is often necessary to mix javascript templates with +- It is often necessary to mix JavaScript templates with HTML templates. A sane approach to this design is to isolate the parts where the HTML template passes some variable content - to the javascript code. + to the JavaScript code. @@ -370,7 +370,7 @@ The `base.html` file can be used as base for all site pages which are for exampl -The next listing is our site page (`site.html`) loaded in the python app which extends `base.html`. The content block is +The next listing is our site page (`site.html`) loaded in the Python app which extends `base.html`. The content block is automatically set into the corresponding block in the base.html page. .. code-block:: html