From 77f4de02e93fb9e15b717235a2916e52f96f8f79 Mon Sep 17 00:00:00 2001
From: Klaas Hoekema <khoekema@azavea.com>
Date: Fri, 20 Oct 2017 21:02:28 -0400
Subject: [PATCH] Shorten usage to one code and one shell example

Rather than having a copy of the `tests.py` file, which is not super
readable and tends to make the eyes glaze over, give one example of
an invocation in code and one on the command line then link to the
tests file.
---
 README.rst | 126 +++++------------------------------------------------
 1 file changed, 11 insertions(+), 115 deletions(-)

diff --git a/README.rst b/README.rst
index a5a62ac..790f161 100644
--- a/README.rst
+++ b/README.rst
@@ -45,131 +45,25 @@ From sources:
 How to use
 ----------
 
+**In code:**
+
 .. code:: python
 
     from slugify import slugify
 
-    txt = "This is a test ---"
-    r = slugify(txt)
-    self.assertEqual(r, "this-is-a-test")
-
-    txt = "___This is a test ---"
-    r = slugify(txt)
-    self.assertEqual(r, "this-is-a-test")
-
-    txt = "___This is a test___"
-    r = slugify(txt)
-    self.assertEqual(r, "this-is-a-test")
-
-    txt = "This -- is a ## test ---"
-    r = slugify(txt)
-    self.assertEqual(r, "this-is-a-test")
-
-    txt = '影師嗎'
-    r = slugify(txt)
-    self.assertEqual(r, "ying-shi-ma")
-
-    txt = 'C\'est déjà l\'été.'
-    r = slugify(txt)
-    self.assertEqual(r, "c-est-deja-l-ete")
-
-    txt = 'Nín hǎo. Wǒ shì zhōng guó rén'
-    r = slugify(txt)
-    self.assertEqual(r, "nin-hao-wo-shi-zhong-guo-ren")
-
-    txt = 'jaja---lol-méméméoo--a'
-    r = slugify(txt)
-    self.assertEqual(r, "jaja-lol-mememeoo-a")
-
-    txt = 'Компьютер'
-    r = slugify(txt)
-    self.assertEqual(r, "kompiuter")
-
-    txt = 'jaja---lol-méméméoo--a'
-    r = slugify(txt, max_length=9)
-    self.assertEqual(r, "jaja-lol")
-
-    txt = 'jaja---lol-méméméoo--a'
-    r = slugify(txt, max_length=15)
-    self.assertEqual(r, "jaja-lol-mememe")
-
-    txt = 'jaja---lol-méméméoo--a'
-    r = slugify(txt, max_length=50)
-    self.assertEqual(r, "jaja-lol-mememeoo-a")
-
-    txt = 'jaja---lol-méméméoo--a'
-    r = slugify(txt, max_length=15, word_boundary=True)
-    self.assertEqual(r, "jaja-lol-a")
+    slug = slugify("C'est déjà l'été.")
+    self.assertEqual(slug, "c-est-deja-l-ete")
 
-    txt = 'jaja---lol-méméméoo--a'
-    r = slugify(txt, max_length=17, word_boundary=True)
-    self.assertEqual(r, "jaja-lol-mememeoo")
+See further examples and optional arguments in (`test.py`_).
 
-    txt = 'jaja---lol-méméméoo--a'
-    r = slugify(txt, max_length=18, word_boundary=True)
-    self.assertEqual(r, "jaja-lol-mememeoo")
 
-    txt = 'jaja---lol-méméméoo--a'
-    r = slugify(txt, max_length=19, word_boundary=True)
-    self.assertEqual(r, "jaja-lol-mememeoo-a")
+**On the command line:**
 
-    txt = 'jaja---lol-méméméoo--a'
-    r = slugify(txt, max_length=20, word_boundary=True, separator=".")
-    self.assertEqual(r, "jaja.lol.mememeoo.a")
-
-    txt = 'jaja---lol-méméméoo--a'
-    r = slugify(txt, max_length=20, word_boundary=True, separator="ZZZZZZ")
-    self.assertEqual(r, "jajaZZZZZZlolZZZZZZmememeooZZZZZZa")
-
-    txt = 'one two three four five'
-    r = slugify(txt, max_length=13, word_boundary=True, save_order=True)
-    self.assertEqual(r, "one-two-three")
-
-    txt = 'one two three four five'
-    r = slugify(txt, max_length=13, word_boundary=True, save_order=False)
-    self.assertEqual(r, "one-two-three")
-
-    txt = 'one two three four five'
-    r = slugify(txt, max_length=12, word_boundary=True, save_order=False)
-    self.assertEqual(r, "one-two-four")
-
-    txt = 'one two three four five'
-    r = slugify(txt, max_length=12, word_boundary=True, save_order=True)
-    self.assertEqual(r, "one-two")
-
-    txt = 'this has a stopword'
-    r = slugify(txt, stopwords=['stopword'])
-    self.assertEqual(r, 'this-has-a')
-
-    txt = 'the quick brown fox jumps over the lazy dog'
-    r = slugify(txt, stopwords=['the'])
-    self.assertEqual(r, 'quick-brown-fox-jumps-over-lazy-dog')
-
-    txt = 'Foo A FOO B foo C'
-    r = slugify(txt, stopwords=['foo'])
-    self.assertEqual(r, 'a-b-c')
-
-    txt = 'Foo A FOO B foo C'
-    r = slugify(txt, stopwords=['FOO'])
-    self.assertEqual(r, 'a-b-c')
-
-    txt = 'the quick brown fox jumps over the lazy dog in a hurry'
-    r = slugify(txt, stopwords=['the', 'in', 'a', 'hurry'])
-    self.assertEqual(r, 'quick-brown-fox-jumps-over-lazy-dog')
-
-    txt = 'foo &amp; bar'
-    r = slugify(txt)
-    self.assertEqual(r, 'foo-bar')
+.. code:: bash
 
-    txt = "___This is a test___"
-    regex_pattern = r'[^-a-z0-9_]+'
-    r = slugify(txt, regex_pattern=regex_pattern)
-    self.assertEqual(r, "___this-is-a-test___")
+    $ slugify "C'est déjà l'été."
+    c-est-deja-l-ete
 
-    txt = "___This is a test___"
-    regex_pattern = r'[^-a-z0-9_]+'
-    r = slugify(txt, separator='_', regex_pattern=regex_pattern)
-    self.assertNotEqual(r, "_this_is_a_test_")
 
 Running the tests
 -----------------
@@ -210,4 +104,6 @@ X.Y.Z Version
 .. |download-image| image:: https://img.shields.io/pypi/dm/python-slugify.svg
     :target: https://pypi.python.org/pypi/python-slugify
 
+.. _test.py: test.py
+
 .. _MIT: https://github.com/un33k/python-slugify/blob/master/LICENSE