nicify some docstrings and descriptions #232
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
|
There were some discussions on whether we should add |
Codecov Report
@@ Coverage Diff @@
## main #232 +/- ##
=======================================
Coverage 55.34% 55.34%
=======================================
Files 48 48
Lines 1610 1610
=======================================
Hits 891 891
Misses 719 719
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Yeah, that could be useful. The descriptions that were shortened were so because they didn't actually provide anything meaningful with all their words: "Time constant of FirstOrder filter" is no more informative than "Time constant" since it's obvious from context, both in the GUI and in the REPL, that it belongs to the FirstORder filter |
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 playing around with the GUI a bit, I realized that some descriptions were overly verbose and at the same time not as informative as they could be.