diff --git a/docs/scenarios/scientific.rst b/docs/scenarios/scientific.rst index 7ad1b1fcd..05e751145 100644 --- a/docs/scenarios/scientific.rst +++ b/docs/scenarios/scientific.rst @@ -129,7 +129,7 @@ Anaconda `Continuum Analytics `_ offers the `Anaconda Python Distribution `_ which -includes all the common scientific python packages and additionally many +includes all the common scientific Python packages and additionally many packages related to data analytics and big data. Anaconda itself is free, and Continuum sells a number of proprietary add-ons. Free licenses for the add-ons are available for academics and researchers. diff --git a/docs/starting/install/win.rst b/docs/starting/install/win.rst index 469a729f0..033a213b4 100644 --- a/docs/starting/install/win.rst +++ b/docs/starting/install/win.rst @@ -53,7 +53,7 @@ download and install any compliant Python software product with a single command. It also enables you to add this network installation capability to your own Python software with very little work. -To obtain the latest version of Setuptools for Windows, run the python script +To obtain the latest version of Setuptools for Windows, run the Python script available here: `ez_setup.py `_ @@ -62,7 +62,7 @@ considered by many to be deprecated, so we will install its replacement: **pip**. Pip allows for uninstallation of packages, and is actively maintained, unlike easy_install. -To install pip, run the python script available here: +To install pip, run the Python script available here: `get-pip.py `_ diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst index b52fca7c4..125b7e79c 100644 --- a/docs/writing/documentation.rst +++ b/docs/writing/documentation.rst @@ -17,7 +17,7 @@ assuming the user knows anything about the project), the url of the main source for the software, and some basic credit information. This file is the main entry point for readers of the code. -An :file:`INSTALL` file is less necessary with python. The installation +An :file:`INSTALL` file is less necessary with Python. The installation instructions are often reduced to one command, such as ``pip install module`` or ``python setup.py install`` and added to the :file:`README` file. @@ -56,7 +56,7 @@ of the following components: Sphinx ~~~~~~ -Sphinx_ is far and away the most popular python documentation +Sphinx_ is far and away the most popular Python documentation tool. **Use it.** It converts :ref:`restructuredtext-ref` markup language into a range of output formats including HTML, LaTeX (for printable PDF versions), manual pages, and plain text. diff --git a/docs/writing/license.rst b/docs/writing/license.rst index 9dd7c86d2..006c045ce 100644 --- a/docs/writing/license.rst +++ b/docs/writing/license.rst @@ -31,7 +31,7 @@ To help you choose one for your project, there's a `license chooser `_ of how the -dot notation should be used in the python docs. +dot notation should be used in the Python docs. If you'd like you could name it as :file:`my_spam.py` but even our friend the underscore should not be seen often in module names. diff --git a/docs/writing/style.rst b/docs/writing/style.rst index 85b601d0a..9ca14896d 100644 --- a/docs/writing/style.rst +++ b/docs/writing/style.rst @@ -360,7 +360,7 @@ Take the following code for example: def lookup_list(l): return 's' in l -Even though both functions look identical, because *lookup_dict* is utilizing the fact that dictionaries in python are hashtables, the lookup performance between the two is very different. +Even though both functions look identical, because *lookup_dict* is utilizing the fact that dictionaries in Python are hashtables, the lookup performance between the two is very different. Python will have to go through each item in the list to find a matching case, which is time consuming. By analysing the hash of the dictionary, finding keys in the dict can be done very quickly. For more information see this `StackOverflow `_ page. diff --git a/docs/writing/tests.rst b/docs/writing/tests.rst index ae99fd155..34add0d8e 100644 --- a/docs/writing/tests.rst +++ b/docs/writing/tests.rst @@ -242,7 +242,7 @@ to newer versions of the module easier in the future class MyTest(unittest.TestCase): ... -This way if you ever switch to a newer python version and no longer need the +This way if you ever switch to a newer Python version and no longer need the unittest2 module, you can simply change the import in your test module without the need to change any other code.