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

Rename first -> lowerbound, last -> upperbound #198

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

haberdashPI
Copy link
Contributor

@haberdashPI haberdashPI commented Aug 2, 2022

This is an experiment to stop overloading first and last from Base, as per #90, since it is very pun-like.

I've tried to strike a balance that makes this minimally disruptive to users of the package, while also making the internal vocabulary used by the package not confusing.

I've renamed these two types

  • LeftEndpoint -> LowerEndpoint
  • RightEndpoint -> UpperEndpoint

Leaving the old names as aliases to avoid breaking old code.

I've also renamed the Direction types to Lower and Upper.

Finally, I've marked this as 2.0 and removed any old deprecations, and added in new ones for first and last as well as the constructors for LeftEndpoint and RightEndpoint.

I think this this would be an improvement in nomenclature, but even with my efforts to avoid disruption, it will still invovle churn.

What do folks think? Is this worth it?

@codecov
Copy link

codecov bot commented Aug 2, 2022

Codecov Report

Merging #198 (e448117) into master (a785b56) will increase coverage by 8.85%.
The diff coverage is 95.47%.

@@            Coverage Diff             @@
##           master     #198      +/-   ##
==========================================
+ Coverage   84.16%   93.02%   +8.85%     
==========================================
  Files          12        9       -3     
  Lines         840      688     -152     
==========================================
- Hits          707      640      -67     
+ Misses        133       48      -85     
Impacted Files Coverage Δ
src/plotting.jl 94.11% <75.00%> (ø)
src/interval_sets.jl 85.41% <93.87%> (-6.50%) ⬇️
src/anchoredinterval.jl 97.45% <95.65%> (-1.67%) ⬇️
src/interval.jl 96.01% <95.83%> (ø)
src/Intervals.jl 100.00% <100.00%> (ø)
src/description.jl 100.00% <100.00%> (ø)
src/endpoint.jl 98.11% <100.00%> (ø)
src/parse.jl 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us.

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.

1 participant