Trim the comments that were review notes - #55
Merged
Conversation
The recent bug fixes left comments explaining why the change was correct, which is PR material rather than something the next reader of the code needs. Keep the one-line narrating comments, drop the justifications.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The bug fixes that landed over the past weeks left behind a few comments that
explain why the change was correct rather than what the code does. That is PR
material, not something the next reader of the script needs -- and it only reads
as necessary because the surrounding line was someone else's bug.
Keeps the one-line narrating comments, drops the justifications:
novel_predict: drop the note onmodel.to(device)entirelylm:# add an intercept column, without thefastLm()explanationcorrelation: one line forpaired_similarity(), one for the zero-variance casemse: one line for the sparse coercionprocess_dataset: one line each for the positional sampling and the batch holdoutNo behaviour change -- comments only.
viash ns buildgreen (38/38), and allfive scripts still parse.