init: add TODO doc-comment for generated module #4638
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
Sija
reviewed
Jun 30, 2017
| @@ -122,8 +122,9 @@ dependencies: | |||
| describe_file "example/src/example.cr" do |example| | |||
| example.should eq(%{require "./example/*" | |||
|
|
|||
| # TODO: Write document for Example | |||
There was a problem hiding this comment.
# TODO: Write documentation for `Example` classThere was a problem hiding this comment.
But Example is not a class.
There was a problem hiding this comment.
You're right, it was meant to be module of course :)
Writing a documentation is good culture.
makenowjust
force-pushed
the
fix/crystal-init/todo-comment-for-doc
branch
from
8d5f992
to
4d10a52
Compare
asterite
approved these changes
Sep 19, 2017
RX14
approved these changes
Sep 19, 2017
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.
Writing a document is good culture 馃槅