Skip to content

Commit

Permalink
add revisions to docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
cleoold committed Dec 1, 2021
1 parent a38abbe commit 47f1b8f
Show file tree
Hide file tree
Showing 9 changed files with 297 additions and 17 deletions.
25 changes: 25 additions & 0 deletions doc/api/more/types_linq.more.more_enumerable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ These APIs may have breaking changes more frequently than those in Enumerable cl
in .NET are happening and sometimes ones of these APIs could be moved to Enumerable with modification,
or changed to accommodate changes to Enumerable.

Revisions:
- v0.2.0: New.

Bases
======
- ``Enumerable[TSource_co]``
Expand Down Expand Up @@ -100,6 +103,9 @@ Example
>>> MoreEnumerable(ints).enumerate().to_list()
[(0, 2), (1, 4), (2, 6)]

Revisions:
- main: New.

----

instancemethod ``except_by2(second, key_selector)``
Expand All @@ -121,6 +127,10 @@ Example
>>> MoreEnumerable(first).except_by2(second, lambda x: x[1]).to_list()
[(16, 'x'), (16, 't')]

Revisions:
- main: Renamed from ``except_by()`` to this name to accommodate the update to Enumerable class.
- v0.2.1: Added preliminary support for unhashable keys.

----

instancemethod ``flatten()``
Expand Down Expand Up @@ -314,6 +324,9 @@ Example
>>> store
{1, 2}

Revisions:
- v0.2.1: New.

----

instancemethod ``rank[TSupportsLessThan]()``
Expand All @@ -332,6 +345,9 @@ Example
>>> MoreEnumerable(scores).rank().to_list()
[6, 5, 2, 3, 3, 5, 4, 7, 8, 1, 3] # 101 is largest, so has rank of 1

Revisions:
- main: New.

----

instancemethod ``rank(__comparer)``
Expand All @@ -348,6 +364,9 @@ Ranks each item in the sequence in descending order using the given comparer.
Such comparer takes two values and return positive ints when lhs > rhs, negative ints
if lhs < rhs, and 0 if they are equal.

Revisions:
- main: New.

----

instancemethod ``rank_by[TSupportsLessThan](key_selector)``
Expand Down Expand Up @@ -377,6 +396,9 @@ Example
... .to_dict(lambda g: g.key, lambda g: g.to_list())
{3: ['Frank'], 2: ['Alica', 'Rogers'], 1: ['Erika']}
Revisions:
- main: New.

----

instancemethod ``rank_by[TKey](key_selector, __comparer)``
Expand All @@ -394,6 +416,9 @@ Ranks each item in the sequence in descending order using the given selector and
Such comparer takes two values and return positive ints when lhs > rhs, negative ints
if lhs < rhs, and 0 if they are equal.

Revisions:
- main: New.

----

staticmethod ``traverse_breath_first[TSource](root, children_selector)``
Expand Down
3 changes: 3 additions & 0 deletions doc/api/types_linq.cached_enumerable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Enumerable that stores the enumerated results which can be accessed repeatedly.

Users should not construct instances of this class directly. Use ``Enumerable.as_cached()`` instead.

Revisions:
- v0.1.1: New.

Bases
======
- ``Enumerable[TSource_co]``
Expand Down
Loading

0 comments on commit 47f1b8f

Please sign in to comment.