Merge pull request #356 from eakman/develop

General proofreading of documentation
nornir-automation · Mar 18, 2019 · 9d154b5 · 9d154b5
2 parents fde4626 + c3d8df9
commit 9d154b5
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,7 +8,7 @@ Welcome to nornir's documentation!
 
 Nornir is an automation framework written in python to be used with python. Most automation
 frameworks hide the language they are written in by using some cumbersome pseudo-language
-which usually is almost Turing complete but lacks tooling to debug and troubleshoot. Integrating
+which usually is almost Turing complete, but lacks tooling to debug and troubleshoot. Integrating
 with other systems is also usually quite hard as they usually have complex APIs if any at all.
 Some of the other common problems of those pseudo-languages is that are usually quite bad
 at dealing with data and re-usability is limited.

diff --git a/docs/tutorials/intro/install.rst b/docs/tutorials/intro/install.rst
@@ -1,7 +1,7 @@
 Installing Nornir
 ==================
 
-Before you go ahead and install Nornir it's recommended to create your own Python virtualenv. That way you have complete control of your environment and you don't risk overwriting your systems Python environment.
+Before you go ahead and install Nornir, it's recommended to create your own Python virtualenv. That way you have complete control of your environment and you don't risk overwriting your systems Python environment.
 
 .. note::
 
@@ -10,7 +10,7 @@ Before you go ahead and install Nornir it's recommended to create your own Pytho
 Nornir is published to `PyPI <https://pypi.org/project/nornir/>`_ and can be installed like most other Python packages using the pip tool. You can verify that you have pip installed by typing:
 
 .. code-block:: bash
-	
+
 	pip --version
 
 	pip 9.0.3 from /Users/patrick/nornir/lib/python3.6/site-packages (python 3.6)
@@ -28,7 +28,7 @@ As you would assume, the installation is then very easy.
 	[...]
 	Successfully installed MarkupSafe-1.0 asn1crypto-0.24.0 bcrypt-3.1.4 nornir-2.0.0
 
-Please note that the above output has been abbreviated for readability. Your output will be quite a bit longer. You should see that `nornir` is successfully installed. 
+Please note that the above output has been abbreviated for readability. Your output will be quite a bit longer. You should see that `nornir` is successfully installed.
 
 Now we can verify that Nornir is installed and that you are able to import the package from Python.
 

diff --git a/docs/tutorials/intro/overview.rst b/docs/tutorials/intro/overview.rst
@@ -5,9 +5,9 @@ Nornir is an automation framework written in Python. These days there exists sev
 
 Why does this matter?
 ---------------------
-Typically, a specific configuration language is easy to use in a basic way. Though after a while you need to use more advanced features and might have to extend that configuration language with another programming language. While this works it can be very hard to troubleshoot once it's started to grow.
+Typically, a specific configuration language is easy to use in a basic way. Though after a while you need to use more advanced features and might have to extend that configuration language with another programming language. While this works, it can be very hard to troubleshoot once it's started to grow.
 
-As Nornir allows you to use pure Python code you can troubleshoot and debug it in the same way as you would do with any other Python code.
+As Nornir allows you to use pure Python code, you can troubleshoot and debug it in the same way as you would do with any other Python code.
 
 What does it compare to?
 ------------------------
@@ -17,4 +17,4 @@ Nornir lets you automate your environment by providing you an interface which do
 
 How much Python do you need do know?
 ------------------------------------
-As you write Python code to control Nornir it's assumed that you are somewhat familiar with Python. But how good do you have to be with Python in order to make use of Nornir? That's actually the topic for the next section *spoiler alert* Not a lot!
+As you write Python code to control Nornir, it's assumed that you are somewhat familiar with Python. But how good do you have to be with Python in order to make use of Nornir? That's actually the topic for the next section *spoiler alert* Not a lot!
diff --git a/docs/tutorials/intro/python.rst b/docs/tutorials/intro/python.rst
@@ -7,7 +7,7 @@ If you haven't written any code before you might be heading somewhere else now.
 
 Do you know Excel?
 
-Chances are that you know how to use Excel. It's simple right. You just open a sheet and enter some data. It's used by a lot of finance people and unfortunately it's one of the most used IPAM solutions. Though aside from a simple tool to enter data in a sheet Excel has an insane amount of features. Most people will only use 5% of all the features. How good are you at Excel? Does it matter?
+Chances are that you know how to use Excel. It's simple right. You just open a sheet and enter some data. It's used by a lot of finance people and unfortunately it's one of the most used IPAM solutions. Though aside from being a simple data entry tool, Excel has an insane amount of features. Most people will only use 5% of all the features. How good are you at Excel? Does it matter?
 
 It's the same way with Python, it can take very long time to fully master it. The good part is that you don't have to become a master. As long as you know the very basics you will be able to use Nornir.