-
Notifications
You must be signed in to change notification settings - Fork 19
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.
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
Make argument names consistent, update docstring, & add units #240
Conversation
FarnazH
commented
Feb 1, 2024
- Update the docstring of the argument center and specify atomic units
- Arguments sectors_degree and deg_sectors were used to refer to degree sectors. so they were both changed to d_sectors.
- sectors_r and radius_sectors were used to refer to radius sectors, so they were both changed to r_sectors. Unit was clarified in docstring.
- Update docstring of argument center and specify atomic units - Arguments sectors_degree and deg_sectors were used to refer to degree sectors. so they were both changed to d_sectors. - sectors_r and radius_sectors were used to refer to radius sectors, so they were both changed to r_sectors. Unit was clarified in docstring.
for more information, see https://pre-commit.ci
The changes are good, but now several tests are failing (I will update them). |
None as defaults is needed for degrees and size so that an angular grid can be created using any of the two without defining the other.
for more information, see https://pre-commit.ci
@FarnazH I had to use defaults ( |
for more information, see https://pre-commit.ci
This commit updates the notebooks for consistency with api changes.
_find_degrees_for_radial_points better tells what the function does.
The function returned degree and size, so the name was confusing.
@marco-2023, the We can talk more about this today, as this is an important API change appearing in other classes as well. |
@Ali-Tehrani and @marco-2023, the notebook failure can be ignored for now. We are changing the API, and just updating the |
- Don't use Union and instead use (a | b)
- Using a legacy import lib
for more information, see https://pre-commit.ci
I'm indifferent on either API choices. As long as it's documented, I'm okay with either. |
My bad , I didn't realize running JCP_paper was installing the master branch of grid and so I was constantly getting errors since the changes in the Pull-request weren't made. I think this is good to merge and will fix most of the problems. |