Merge pull request #5694 from ThomasWaldmann/misc-fixes-1.1

backport comment about archives.list() defaults
This commit is contained in:
TW 2021-02-15 21:40:27 +01:00 committed by GitHub
commit 4a181f74a4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -279,6 +279,10 @@ class Archives(abc.MutableMapping):
Apply *first* and *last* filters, and then possibly *reverse* the list.
*sort_by* is a list of sort keys applied in reverse order.
Note: for better robustness, all filtering / limiting parameters must default to
"not limit / not filter", so a FULL archive list is produced by a simple .list().
some callers EXPECT to iterate over all archives in a repo for correct operation.
"""
if isinstance(sort_by, (str, bytes)):
raise TypeError('sort_by must be a sequence of str')