-
-
Notifications
You must be signed in to change notification settings - Fork 1
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
refactor!: remove not particularly useful features #418
Merged
muktihari
merged 22 commits into
master
from
refactor/remove-not-particularly-useful-feature
Sep 12, 2024
Merged
refactor!: remove not particularly useful features #418
muktihari
merged 22 commits into
master
from
refactor/remove-not-particularly-useful-feature
Sep 12, 2024
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #418 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 41 41
Lines 3695 3612 -83
=========================================
- Hits 3695 3612 -83 ☔ View full report in Codecov by Sentry. |
…d as we might change the behavior later
muktihari
force-pushed
the
refactor/remove-not-particularly-useful-feature
branch
from
September 12, 2024 07:21
e55bd82
to
ad1f957
Compare
muktihari
force-pushed
the
refactor/remove-not-particularly-useful-feature
branch
from
September 12, 2024 07:23
ad1f957
to
1961084
Compare
muktihari
deleted the
refactor/remove-not-particularly-useful-feature
branch
September 12, 2024 07:28
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.
After 1 year of using this SDK to create programs. I find that some features are not particularly useful such as
(Message) WithMessages
andfactory.CreateMesgOnly
, we can just directly assign the value. Some of them can be omitted when certain features do not exist to begin with such asinternal/kit
package. I find some abstractions are a bit confusing such asReserved
andArchitecture
fields in proto.Message, these fields are just copied from proto.MessageDefinition during decoding and this does not add any value to my program.These features/values were created at the time when I still didn't know the proper way to implementation of FIT protocol. Now I think these can be simplified.
This PR cleaning up those elements to help us maintain cleaner code in the future.
What's changed with breaking changes:
1. Behavior
decoder's Decode() and DecodeWithContext() are no longer required to be wrapped inside Next() loop, these methods can be invoked multiple times to decode chained FIT file directly. Method Next() is now just a convenience tool to do iteration.
2. Modified
Functions
Methods
Structs or Fields
value
values
Errors
3. Removed
Package
Functions
Methods
Constants