refactor: Remove "Opts" abbreviation #92
Merged
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 Report
@@ Coverage Diff @@
## main #92 +/- ##
==========================================
+ Coverage 68.84% 71.60% +2.75%
==========================================
Files 85 89 +4
Lines 3396 3578 +182
Branches 55 55
==========================================
+ Hits 2338 2562 +224
+ Misses 861 793 -68
- Partials 197 223 +26
Continue to review full report at Codecov.
|
Having a mixture of abbreviations in the codebase reduces clarity. Although opts is common for options, I'd rather set a precedent of clarifying verbosity.
bryphe-coder
approved these changes
Jan 30, 2022
There was a problem hiding this comment.
I like it, thanks for improving the readability @kylecarbs !
jawnsy
reviewed
Jan 30, 2022
| @@ -27,7 +27,7 @@ const ( | |||
| // The initialization overrides listener handles, and detaches | |||
| // the channel on open. The datachannel should not be manually | |||
| // mutated after being passed to this function. | |||
| func newChannel(conn *Conn, dc *webrtc.DataChannel, opts *ChannelOpts) *Channel { | |||
| func newChannel(conn *Conn, dc *webrtc.DataChannel, opts *ChannelOptions) *Channel { | |||
There was a problem hiding this comment.
consider following up with a ruleguard linter rule that checks that types don't end in Opts, and suggesting Options instead
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.
Having a mixture of abbreviations in the codebase reduces
clarity. Although opts is common for options, I'd rather
set a precedent of clarifying verbosity.