Update docs - Make code snippet self-contained. #118017
Open
Conversation
This file contains hidden or 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
Update the comparison functions code snippet to be self-contained. Use the names list from a previous example instead of words.
Update comparison functions code snippet to be self-contained. Use names list from previous example instead of words.
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
docs
|
IMO, it would be better to find a different example here:
|
Comment on lines
+273
to
+280
| ..doctest:: | ||
|
|
||
| >>> from functools import cmp_to_key | ||
| >>> from locale import strcoll | ||
|
|
||
| >>> names = 'Zo毛 脜bj酶rn N煤帽ez 脡lana Zeke Abe Nubia Eloise'.split() | ||
| >>> sorted(names, key=cmp_to_key(strcoll)) # locale-aware sort order | ||
| ['Abe', 'Eloise', 'Nubia', 'N煤帽ez', 'Zeke', 'Zo毛', '脜bj酶rn', '脡lana'] |
There was a problem hiding this comment.
Suggested change
| ..doctest:: | |
| >>> from functools import cmp_to_key | |
| >>> from locale import strcoll | |
| >>> names = 'Zo毛 脜bj酶rn N煤帽ez 脡lana Zeke Abe Nubia Eloise'.split() | |
| >>> sorted(names, key=cmp_to_key(strcoll)) # locale-aware sort order | |
| ['Abe', 'Eloise', 'Nubia', 'N煤帽ez', 'Zeke', 'Zo毛', '脜bj酶rn', '脡lana'] | |
| .. code-block:: | |
| >>> from functools import cmp_to_key | |
| >>> from locale import strcoll | |
| >>> names = 'Zo毛 脜bj酶rn N煤帽ez 脡lana Zeke Abe Nubia Eloise'.split() | |
| >>> sorted(names, key=cmp_to_key(strcoll)) # locale-aware sort order | |
| ['Abe', 'Eloise', 'Nubia', 'N煤帽ez', 'Zeke', 'Zo毛', '脜bj酶rn', '脡lana'] |
To avoid the doctest issues.
Comment on lines
+273
to
+280
| ..doctest:: | ||
|
|
||
| >>> from functools import cmp_to_key | ||
| >>> from locale import strcoll | ||
|
|
||
| >>> names = 'Zo毛 脜bj酶rn N煤帽ez 脡lana Zeke Abe Nubia Eloise'.split() | ||
| >>> sorted(names, key=cmp_to_key(strcoll)) # locale-aware sort order | ||
| ['Abe', 'Eloise', 'Nubia', 'N煤帽ez', 'Zeke', 'Zo毛', '脜bj酶rn', '脡lana'] |
There was a problem hiding this comment.
Suggested change
| ..doctest:: | |
| >>> from functools import cmp_to_key | |
| >>> from locale import strcoll | |
| >>> names = 'Zo毛 脜bj酶rn N煤帽ez 脡lana Zeke Abe Nubia Eloise'.split() | |
| >>> sorted(names, key=cmp_to_key(strcoll)) # locale-aware sort order | |
| ['Abe', 'Eloise', 'Nubia', 'N煤帽ez', 'Zeke', 'Zo毛', '脜bj酶rn', '脡lana'] | |
| .. code-block:: | |
| >>> from functools import cmp_to_key | |
| >>> def compare_abs(x, y): | |
| ... """Sort by absolute value, prioritizing negatives""" | |
| ... if abs(x) != abs(y): | |
| ... return (abs(x) > abs(y)) - (abs(x) < abs(y)) | |
| ... return (x > y) - (x < y) | |
| >>> numbers = [5, -1, 2, -5, 3, -2, 1] | |
| >>> sorted(numbers, key=cmp_to_key(compare_abs)) | |
| [-1, 1, -2, 2, 3, -5, 5] |
As for a different example, @encukou WDYT?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
馃摎 Documentation preview 馃摎: https://cpython-previews--118017.org.readthedocs.build/