refactor: rename is_start kwarg in private methods to is_seg_start
#359
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
korikuzma
added
priority:medium
|
I think that private methods kind of definitionally can't cause breaking changes. They aren't part of the API, even if they hypothetically can be accessed -- we aren't responsible for their stability between versions. Otherwise, there isn't really much of a point in designating methods as private/internal in the first place. |
korikuzma
changed the title
is_start kwarg in private methods to is_seg_startis_start kwarg in private methods to is_seg_start
jsstevenson
previously approved these changes
Aug 20, 2024
korikuzma
added
priority:low
addresses #224 * No code was changed in the classes or methods
korikuzma
force-pushed
the
organize-mapper
branch
from
18b9118
to
1539ccc
Compare
korikuzma
force-pushed
the
rename-is-start
branch
from
eb2a023
to
b9d80fc
Compare
jarbesfeld
approved these changes
Aug 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
addresses #224
@jsstevenson not sure what our convention is if a breaking change occurs in private methods. Theoretically, since they have a leading underscore they are meant to be internal but if people still choose to use these methods they should be aware? Kept going back and forth on this (as I always do with conventional commits it feels like).