Use GetValidName() throughout Python bindings #3302
Merged
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.
@NippunSharma added a function called
GetValidName()
, which maps binding parameters from their given name to a name suitable for Python:mlpack/src/mlpack/bindings/python/wrapper_functions_impl.hpp
Lines 34 to 43 in 3f37143
Specifically, this maps
lambda
tolambda_
, sincelambda
is a reserved keyword in Python, and it also mapsinput
toinput_
, sinceinput()
is a builtin function in Python.This PR changes all of our documentation functions in Python to use
GetValidName()
, instead of manually making the same change forlambda
tolambda_
everywhere. After this PR is merged, the documentation will correctly reflect theinput_
name instead ofinput
; that is, the documentation is currently being printed incorrectly. It confused me for a few minutes while I was debugging the Python bindings. :)