DOC: Fix default value for engine in pandas.eval #63382
Open
+4
−3
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.
Update docstring to match signature default of None. Also clarify description of numexpr engine.
engineargument inevalshould beNone#63376doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.AGENTS.md.Description
Updates the docstring for the
engineparameter inpandas.eval(located inpandas/core/computation/eval.py) to reflect that the default value in the function signature isNone.Previously documented as
default 'numexpr', it has been corrected tooptional, default Noneto match the signatureengine: str | None = None.The description for the
'numexpr'engine was also updated to remove the phrase "This default engine" to avoid contradiction with the new parameter description.Validation
Ran the docstring validation script locally:
python scripts/validate_docstrings.py pandas.eval