Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reorganize docs. Move almost everything out of the readme.
Rewrite intro. Add Conditions for Contributors.
- Loading branch information
Showing
6 changed files
with
82 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
============= | ||
API Reference | ||
============= | ||
|
||
.. automodule:: more_itertools | ||
|
||
.. autofunction:: first(iterable[, default]) | ||
.. autofunction:: chunked | ||
.. autofunction:: collate(*iterables, key=lambda a: a, reverse=False) | ||
.. autoclass:: peekable |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,24 @@ | ||
======================== | ||
more-itertools functions | ||
======================== | ||
============== | ||
More Itertools | ||
============== | ||
|
||
.. automodule:: more_itertools | ||
I love itertools; it's one of the most beautiful, composable standard libs. | ||
Whenever I have an iteration problem, there's almost always an itertools | ||
routine that fits it perfectly. Sometimes, however, neither itertools nor the | ||
recipes included in its docs do quite what I need. | ||
|
||
.. autofunction:: first(iterable[, default]) | ||
.. autofunction:: chunked | ||
.. autofunction:: collate(*iterables, key=lambda a: a, reverse=False) | ||
.. autoclass:: peekable | ||
Here I've collected several routines I've reached for but not found. Since | ||
they are deceptively tricky to get right, I thought I'd wrap them up into a | ||
library. Enjoy! Any additions are welcome; just file a pull request. | ||
|
||
|
||
Contents | ||
======== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
api | ||
license | ||
testing | ||
versions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
======= | ||
License | ||
======= | ||
|
||
more-itertools is under the MIT License. See the LICENSE file. | ||
|
||
Conditions for Contributors | ||
=========================== | ||
|
||
By contributing to this software project, you are agreeing to the following | ||
terms and conditions for your contributions: First, you agree your | ||
contributions are submitted under the BSD license. Second, you represent you | ||
are authorized to make the contributions and grant the license. If your | ||
employer has rights to intellectual property that includes your contributions, | ||
you represent that you have received permission to make contributions and grant | ||
the required license on behalf of that employer. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
======= | ||
Testing | ||
======= | ||
|
||
more-itertools uses nose for its tests. First, install nose:: | ||
|
||
pip install nose | ||
|
||
Then, run the tests like this:: | ||
|
||
nosetests | ||
|
||
It should also be possible to say ``python setup.py test``. However, some part | ||
of the test runner throws an error after the tests pass. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
=============== | ||
Version History | ||
=============== | ||
|
||
1.1 | ||
* Added ``first`` function. | ||
* Added Python 3 support. | ||
* Rewrote documentation. | ||
|
||
1.0 | ||
* Initial release, with ``collate``, ``peekable``, and ``chunked``. Could | ||
really use better docs. |