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.

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

feat: rename pos vel acc #200

Merged
merged 5 commits into from
Oct 22, 2024
Merged

Conversation

nstarman
Copy link
Contributor

@nstarman nstarman commented Oct 5, 2024

Shorten the names of most classes. Meaning still obvious.
When we add docs (hopefully soon) this will go into the conventions page.

@adrn what do you think?

@nstarman nstarman added this to the v0.11.0 milestone Oct 5, 2024
@nstarman nstarman requested a review from adrn October 5, 2024 16:59
Copy link

codecov bot commented Oct 5, 2024

Codecov Report

Attention: Patch coverage is 94.43414% with 30 lines in your changes missing coverage. Please review.

Project coverage is 95.92%. Comparing base (3146bda) to head (cd2a95a).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/coordinax/_src/d3/lonlatspherical.py 72.22% 5 Missing ⚠️
src/coordinax/_src/d3/mathspherical.py 78.57% 3 Missing ⚠️
src/coordinax/_src/d3/transform.py 82.35% 3 Missing ⚠️
src/coordinax/_src/dn/cartesian.py 88.46% 3 Missing ⚠️
src/coordinax/_src/d1/cartesian.py 92.59% 2 Missing ⚠️
src/coordinax/_src/d1/compat.py 33.33% 2 Missing ⚠️
src/coordinax/_src/d2/cartesian.py 92.85% 2 Missing ⚠️
src/coordinax/_src/d2/polar.py 84.61% 2 Missing ⚠️
src/coordinax/_src/d3/cartesian.py 93.10% 2 Missing ⚠️
src/coordinax/_src/d3/cylindrical.py 83.33% 2 Missing ⚠️
... and 4 more
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #200   +/-   ##
=======================================
  Coverage   95.92%   95.92%           
=======================================
  Files          78       78           
  Lines        2946     2946           
=======================================
  Hits         2826     2826           
  Misses        120      120           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nstarman nstarman changed the title Rename pos vel acc feat: rename pos vel acc Oct 6, 2024
Copy link

@adrn adrn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not strongly opposed or in favor of this, but want to talk it through. One other place where words could be shortened is in the prefix (Cart/Sph/Cyl/etc.). I'm curious to hear if you have any thoughts about pros/cons to abbreviating the prefix instead of pos/vel/acc, or both, or neither.

Comment on lines 7 to 11
# Pos
"AbstractPos",
# Vel
"AbstractVel",
# Acc
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Total nit pick, but comments should probably stay as full words Position, Velocity, Acceleration.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Product of global find & replace

@nstarman
Copy link
Contributor Author

nstarman commented Oct 8, 2024

I'm not opposed to shortening the prefix either / instead. The goal was to see if it's worth shortening the otherwise long names. I'm still not sure shortening is a good idea 😅.

@nstarman nstarman force-pushed the rename-pos-vel-acc branch 2 times, most recently from f51ca49 to e7d425b Compare October 14, 2024 21:59
@nstarman nstarman modified the milestones: v0.11.0, v0.12.0 Oct 14, 2024
nstarman and others added 4 commits October 18, 2024 18:55
Signed-off-by: nstarman <nstarman@users.noreply.github.com>
Signed-off-by: nstarman <nstarman@users.noreply.github.com>
Signed-off-by: nstarman <nstarman@users.noreply.github.com>
@adrn
Copy link

adrn commented Oct 22, 2024

We discussed this in person and decided to move forward with the name shortening.

@nstarman nstarman marked this pull request as ready for review October 22, 2024 13:37
Signed-off-by: nstarman <nstarman@users.noreply.github.com>
@nstarman nstarman merged commit eb4dd7f into GalacticDynamics:main Oct 22, 2024
13 of 14 checks passed
@nstarman nstarman deleted the rename-pos-vel-acc branch October 22, 2024 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants