Fix up issues detected by proselint

sigmavirus24 · sigmavirus24 · commit 2fe04c1941be · 2018-04-19T21:29:47.000-05:00
Hack together some extra logic in our bash script to ignore typography
errors since proselint doesn't have project-local config that we can
use.
diff --git a/docs/source/api-reference/api.rst b/docs/source/api-reference/api.rst
@@ -16,7 +16,7 @@ Module Contents
 
 To interact with the GitHub API you can either authenticate to access protected
 functionality or you can interact with it anonymously. Authenticating provides
-more functionality to the the user (developer).
+more functionality to the user (developer).
 
 To authenticate, you may use :func:`github3.login`.
 
diff --git a/docs/source/examples/issue.rst b/docs/source/examples/issue.rst
@@ -3,8 +3,8 @@ Issue Code Examples
 
 Examples using ``Issue``\ s
 
-Administrating Issues
----------------------
+Administering Issues
+--------------------
 
 Let's assume you have your username and password stored in ``user`` and ``pw``
 respectively, you have your repository name stored in ``repo``, and the number
diff --git a/docs/source/examples/oauth.rst b/docs/source/examples/oauth.rst
@@ -10,7 +10,7 @@ intention is to have users authenticate, you have a few options.
    application. (Or save the username somewhere, and just ask for the
    password.)
 2. Ask the user to supply their credentials once and store them somewhere for
-   later use. (**VERY VERY BAD**)
+   later use.
 3. Ask the user to supply their credentials once, get an authorization token
    and store that for later use.
 
@@ -75,7 +75,5 @@ privileges, you simply do the following:
     # token == auth.token
     # in case the update changes the token
 
-Hopefully this helps someone.
-
 .. _redirects: http://developer.github.com/v3/oauth/#redirect-urls
 .. _scopes: http://developer.github.com/v3/oauth/#scopes
diff --git a/docs/source/examples/octocat.rst b/docs/source/examples/octocat.rst
@@ -9,14 +9,14 @@ What you should see
 ::
 
 
-    Hey Octocat!
+    Hey Octocat
 
                MMM.           .MMM
                MMMMMMMMMMMMMMMMMMM
-               MMMMMMMMMMMMMMMMMMM      __________
-              MMMMMMMMMMMMMMMMMMMMM    |          |
-             MMMMMMMMMMMMMMMMMMMMMMM   | Hey Ian! |
-            MMMMMMMMMMMMMMMMMMMMMMMM   |_   ______|
+               MMMMMMMMMMMMMMMMMMM      _________
+              MMMMMMMMMMMMMMMMMMMMM    |         |
+             MMMMMMMMMMMMMMMMMMMMMMM   | Hey Ian |
+            MMMMMMMMMMMMMMMMMMMMMMMM   |_   _____|
             MMMM::- -:::::::- -::MMMM    |/
              MM~:~   ~:::::~   ~:~MM
         .. MMMMM::. .:::+:::. .::MMMMM ..
diff --git a/docs/source/examples/source/octocat_say.py b/docs/source/examples/source/octocat_say.py
@@ -1,7 +1,7 @@
 import github3
 
-print("Hey Octocat!")
-print(github3.octocat("Hey Ian!"))
+print("Hey Octocat")
+print(github3.octocat("Hey Ian"))
 print("What do you think about github3.py?")
 print(github3.octocat("github3.py rocks!"))
 print("Thanks Octocat, that means a lot coming from you.")
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -168,60 +168,6 @@ Contact
 .. _@sigmavirus24: https://twitter.com/sigmavirus24
 
 
-Testimonials
-============
-
-.. raw:: html
-
-    <blockquote class="twitter-tweet"><p>gotta hand it to @<a
-    href="https://twitter.com/sigmavirus24">sigmavirus24</a> ... github3.py is
-    really well written. It will soon be powering the github stuff on
-    @<a href="https://twitter.com/workforpie">workforpie</a>
-    </p>&mdash; Brad Montgomery # (@bkmontgomery) <a
-    href="https://twitter.com/bkmontgomery/status/325644863561400320">April 20, 2013</a>
-    </blockquote>
-
-    <blockquote class="twitter-tweet"><p>awesome github v3 api wrapper in
-    python <a href="https://t.co/PhD0Aj5X"
-    title="https://github.com/sigmavirus24/github3.py">github.com/sigmavirus24/g#</a></p>&mdash;
-    Mahdi Yusuf (@myusuf3) <a
-    href="https://twitter.com/myusuf3/status/258571050927915008">October 17,
-    2012</a></blockquote>
-
-    <blockquote class="twitter-tweet">
-    <p>@<a href="https://twitter.com/sigmavirus24">sigmavirus24</a> github3 is
-    awesome! Made my life much easier tonight, which is a very good
-    thing.</p>&mdash; Mike Grouchy (@mgrouchy) <a
-    href="https://twitter.com/mgrouchy/status/316370772782350336">March 26,
-    2013</a></blockquote>
-
-    <blockquote class="twitter-tweet" data-conversation="none">
-    <p>@<a href="https://twitter.com/sigmavirus24">sigmavirus24</a> "There are
-    so many Python client libraries for GitHub API, I tried all of them, and
-    my conclusion is: github3.py is the best."</p>&mdash; Hong Minhee
-    (@hongminhee) <a
-    href="https://twitter.com/hongminhee/status/315295733899210752">March 23,
-    2013</a></blockquote>
-
-    <blockquote class="twitter-tweet">
-    <p>@<a href="https://twitter.com/sigmavirus24">sigmavirus24</a> I cannot
-    wait to use your github package for <a
-    href="https://twitter.com/search/%23zci">#zci</a>. Do you have it packaged
-    for debian by any chance?</p>&mdash; Zygmunt Krynicki (@zygoon) <a
-    href="https://twitter.com/zygoon/status/316608301527887872">March 26,
-    2013</a></blockquote>
-
-    <blockquote class="twitter-tweet">
-    <p>Developing against github3.py's API is a joy, kudos to @<a
-    href="https://twitter.com/sigmavirus24">sigmavirus24</a></p>&mdash;
-    Alejandro Gomez (@dialelo) <a
-    href="https://twitter.com/dialelo/status/316846075015229440">March 27,
-    2013</a></blockquote>
-
-    <script async src="//platform.twitter.com/widgets.js"
-    charset="utf-8"></script>
-
-
 .. links
 
 .. _GitHub API:
diff --git a/docs/source/release-notes/0.3.0.rst b/docs/source/release-notes/0.3.0.rst
@@ -52,12 +52,12 @@
 
     import github3
 
-    r = github3.repository('sigmavirus24', 'github3.py')
+    repo = github3.repository('sigmavirus24', 'github3.py')
 
     template = """Some kind of template where you mention this repository
     {0}"""
 
-    print(template.format(r))
+    print(template.format(repo))
     # Some kind of template where you mention this repository
     # sigmavirus24/github3.py
 
diff --git a/docs/source/release-notes/1.0.0.rst b/docs/source/release-notes/1.0.0.rst
@@ -4,7 +4,7 @@
 -----------------
 
 1.0.0 is a huge release. It includes a great deal of changes to ``github3.py``.
-It is suggested you read the following release notes *very* carefully.
+It is suggested you read the following release notes carefully.
 
 Unfortunately, it's plausible that some things have slipped through the cracks
 in these release notes.
diff --git a/tests/bin/.doclint.swp b/tests/bin/.doclint.swp
diff --git a/tests/bin/doclint b/tests/bin/doclint
@@ -0,0 +1,9 @@
+#!/bin/sh
+
+output="$(find docs/source -name '*.rst' | xargs proselint)"
+exit_code=$?
+
+if echo "$output" | grep -qve 'typography' ; then
+    echo $output
+    exit $exit_code
+fi
