Repository navigation
Conversation
This branch has not been deployed
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
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.
Addresses #548.
get_intreats its first argument as a sequence of successive keys. A callermay try
get_in('x', {'x': 5}), see it work, and expect a longer string to nameone key too. Instead,
get_in('name', {'name': 'Alice'})returns the default,and a string like
'xy'can silently selectdata['x']['y']instead ofdata['xy'].Explain this in the function's API documentation and show both outcomes next
to the single-key list spelling. The examples use explicit return values,
including a dictionary where the nested path and whole string key differ.
They execute with the project's existing doctest command. This is documentation
of the current behavior; the function body and public API are unchanged.
Validation: the existing pytest/doctest entry reports 268 passed and 2 skipped,
the benchmark suite reports 19 passed, and pycodestyle and strict HTML building
pass. Five new doctest steps live within the existing function's doctest item;
they do not add five pytest items. Independent review checked both direct and
curried usage and confirmed that only the docstring changes.
Codex drafted and tested the documentation; a separate Codex agent reviewed it.
I have reviewed and understand the changes.