1. Jonathan Eunice
  2. textdata

Commits

Jonathan Eunice  committed a84602f

further doc tweaks

  • Participants
  • Parent commits 6bce275
  • Branches default

Comments (0)

Files changed (2)

File README.rst

View file
     * ``text`` is the text to be processed. 
     * ``noblanks`` => all blank lines are eliminated, not just starting and ending ones. (default ``True``). 
     * ``dedent`` => strip a common prefix (usually whitespace) from each line (default ``True``). 
-    * ``lstrip`` => strip all left (leading) space from each line (default ``False``). Note that ``lstrip`` and ``dedent`` are  mutualy exclusive ways of handling leading space. 
+    * ``lstrip`` => strip all left (leading) space from each line (default ``False``). Note
+       that ``lstrip`` and ``dedent`` are  mutualy exclusive ways of handling leading space. 
     * ``rstrip`` => strip all right (trailing) space from each line (default ``True``)
 
 ``textlines(text, noblanks=True, dedent=True, lstrip=False, rstrip=True)``
     Does the same helpful cleanups as ``lines()``, but returns result as a single string, with lines
     separated by newlines (and without a trailing newline).
 
-    
+Design Notes
+============
+
+It's tempting to define a constant such as ``Dedent``  that might be the default for
+the ``lstrip`` parameter, instead of having separate ``dedent`` and ``lstrip`` booleans.
+The more I use singleton classes in Python as designated special values, the more
+useful they seem.
+
 Installation
 ============
 

File setup.py

View file
 
 setup(
     name='textdata',
-    version=verno("0.013"),
+    version=verno("0.011"),
     author='Jonathan Eunice',
     author_email='jonathan.eunice@gmail.com',
     description='Get clean line or text data from multi-line strings',
     long_description=open('README.rst', 'r').read(),
-    url='',
+    url='https://bitbucket.org/jeunice/textdata',
     py_modules=['textdata'],
     install_requires=[],
     classifiers=[