Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: Update variables a and b to names consistent with comment documentation #60366

Open
1 task done
migelogali opened this issue Nov 20, 2024 · 1 comment · May be fixed by #60372
Open
1 task done

DOC: Update variables a and b to names consistent with comment documentation #60366

migelogali opened this issue Nov 20, 2024 · 1 comment · May be fixed by #60372
Assignees
@mingjji
Labels
Clean expressions pd.eval, query

Comments

@migelogali
Copy link

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://github.com/pandas-dev/pandas/blob/main/pandas/core/computation/expressions.py

Documentation problem

Lines 234 and 235 explain what a and b are in detail (left and right operands), but there are many of those same variables earlier in the file, making it harder to understand what they represent.

Suggested fix for documentation

Assuming a and b represent right and left operands throughout each function, change these variable names to right_op and left_op instead throughout all functions to have more descriptive variable names
@migelogali migelogali added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Nov 20, 2024
@mingjji
Copy link

mingjji commented Nov 20, 2024

take

mingjji added a commit to mingjji/pandas that referenced this issue Nov 20, 2024
@mingjji
DOC: Update variables a and b to names consistent with comment docume…
d409d9d 
…ntation pandas-dev#60366
@mingjji mingjji linked a pull request Nov 20, 2024 that will close this issue
Open
1 task
@rhshadrach rhshadrach added Clean expressions pd.eval, query and removed Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Nov 21, 2024
mingjji added a commit to mingjji/pandas that referenced this issue Nov 23, 2024
@mingjji
DOC: Update variables a and b to names consistent with comment docume…
ab761f9 
…ntation pandas-dev#60366
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mingjji mingjji

Labels
Clean expressions pd.eval, query
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: Update variables a and b to names consistent with comment docume… mingjji/pandas
3 participants
@rhshadrach @migelogali @mingjji