Add comments to indicate where imports can be added #53
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
chshersh
reviewed
Jan 29, 2022
src/Lecture3.hs
Outdated
Comment on lines
37
to
39
| {- | If you need to import libraries, do it after this line ... -} | ||
|
|
||
| {- | ... and before this line. Otherwise the test suite might fail -} |
There was a problem hiding this comment.
I think we need to have such a comment only in this file. Because only this module has the $setup part that needs to happen after imports. The rest are fine 🙂
Also, I've added some arrows to attract more attention 👀
Suggested change
| {- | If you need to import libraries, do it after this line ... -} | |
| {- | ... and before this line. Otherwise the test suite might fail -} | |
| {- VVV If you need to import libraries, do it after this line ... VVV -} | |
| {- ^^^ ... and before this line. Otherwise, the test suite might fail ^^^ -} |
There was a problem hiding this comment.
My reasoning for adding them to all files was:
- Instructional: show people where it is customary to add imports.
- Non-spoilery: I think
Lecture3.hsis the first set of exercises where importing a library might make it easier, but no need to give that away?
Like the arrows ;-)
There was a problem hiding this comment.
@bulters Makes sense 🙂 I agree with that. In that case, if you could add arrows to all newly introduced sections, happy to merge 👍🏻
marcgreen
pushed a commit
to marcgreen/exercises
that referenced
this pull request
Feb 13, 2022
…s-2022#53) * Add comments to indicate where imports can be added * Add arrows to indicate where imports can be added Co-authored-by: Dmitrii Kovanikov <kovanikov@gmail.com>
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.
This is to fix issue #52