Skip to content

Commit 47f1b8f

Browse files
committed
add revisions to docstrings
1 parent a38abbe commit 47f1b8f

9 files changed

+297
-17
lines changed

doc/api/more/types_linq.more.more_enumerable.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ These APIs may have breaking changes more frequently than those in Enumerable cl
1616
in .NET are happening and sometimes ones of these APIs could be moved to Enumerable with modification,
1717
or changed to accommodate changes to Enumerable.
1818

19+
Revisions:
20+
- v0.2.0: New.
21+
1922
Bases
2023
======
2124
- ``Enumerable[TSource_co]``
@@ -100,6 +103,9 @@ Example
100103
>>> MoreEnumerable(ints).enumerate().to_list()
101104
[(0, 2), (1, 4), (2, 6)]
102105

106+
Revisions:
107+
- main: New.
108+
103109
----
104110

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

130+
Revisions:
131+
- main: Renamed from ``except_by()`` to this name to accommodate the update to Enumerable class.
132+
- v0.2.1: Added preliminary support for unhashable keys.
133+
124134
----
125135

126136
instancemethod ``flatten()``
@@ -314,6 +324,9 @@ Example
314324
>>> store
315325
{1, 2}
316326

327+
Revisions:
328+
- v0.2.1: New.
329+
317330
----
318331

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

348+
Revisions:
349+
- main: New.
350+
335351
----
336352

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

367+
Revisions:
368+
- main: New.
369+
351370
----
352371

353372
instancemethod ``rank_by[TSupportsLessThan](key_selector)``
@@ -377,6 +396,9 @@ Example
377396
... .to_dict(lambda g: g.key, lambda g: g.to_list())
378397
{3: ['Frank'], 2: ['Alica', 'Rogers'], 1: ['Erika']}
379398
399+
Revisions:
400+
- main: New.
401+
380402
----
381403

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

419+
Revisions:
420+
- main: New.
421+
397422
----
398423

399424
staticmethod ``traverse_breath_first[TSource](root, children_selector)``

doc/api/types_linq.cached_enumerable.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ Enumerable that stores the enumerated results which can be accessed repeatedly.
1212

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

15+
Revisions:
16+
- v0.1.1: New.
17+
1518
Bases
1619
======
1720
- ``Enumerable[TSource_co]``

0 commit comments

Comments
 (0)