Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

init: add TODO doc-comment for generated module #4638

Merged

Conversation

makenowjust
Copy link
Contributor

Writing a document is good culture 😆

@@ -122,8 +122,9 @@ dependencies:
describe_file "example/src/example.cr" do |example|
example.should eq(%{require "./example/*"

# TODO: Write document for Example
Copy link
Contributor

@Sija Sija Jun 30, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# TODO: Write documentation for `Example` class

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But Example is not a class.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, it was meant to be module of course :)

Writing a documentation is good culture.
@makenowjust makenowjust force-pushed the fix/crystal-init/todo-comment-for-doc branch from 8d5f992 to 4d10a52 Compare June 30, 2017 11:20
@makenowjust
Copy link
Contributor Author

@mverzilli @RX14 @asterite 🏓

@RX14 RX14 added this to the Next milestone Sep 19, 2017
@RX14 RX14 merged commit 3a292de into crystal-lang:master Sep 19, 2017
@makenowjust makenowjust deleted the fix/crystal-init/todo-comment-for-doc branch September 19, 2017 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants