Skip to content

Commit

Permalink
Minor documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
runfalk committed Dec 22, 2015
1 parent 1506c7c commit 832b5d4
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ preview-readme:
retext README.preview.rst
rm README.preview.rst

.PHONY : init clean-pyc test sdist preview-readme
.PHONY : clean-pyc doc test sdist preview-readme
2 changes: 2 additions & 0 deletions doc/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Not released yet
- Added `Sphinx <http://sphinx-doc.org/>`_ style doc strings to all methods
- Added proper Sphinx documentation
- Added unit tests for uncovered parts, mostly error checking
- Added `wheel <https://www.python.org/dev/peps/pep-0427/>`_ to PyPI along with
source distribution
- Fixed a potential bug where comparing ranges of different types would result
in an infinite loop
- Changed meta class implementation for range sets to allow more mixins for
Expand Down
9 changes: 7 additions & 2 deletions doc/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@ For a recent project of mine I started using PostgreSQL's ``tsrange`` type and n

Requirements
------------
Spans have no requirements but the standard library.
Spans have no requirements but the standard library. It is known to work on the following Python versions

- Python 2.7+ or 3.4+ (may work on other versions too)
- Python 2.7
- Python 3.3
- Python 3.4
- Python 3.5

It may work on other version as well.

Installation
------------
Expand Down
2 changes: 2 additions & 0 deletions doc/recipe_overlap.inc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ Spans make working with intervals of time easy. In this example we want to list
(span.upper.seconds // 60) % 60,
))

This code outputs:

.. testoutput::

Monday 15:00-17:00
Expand Down

0 comments on commit 832b5d4

Please sign in to comment.