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

Spec description grammer [docs] #4444

Merged
merged 2 commits into from May 26, 2017
Merged

Spec description grammer [docs] #4444

merged 2 commits into from May 26, 2017

Conversation

mjago
Copy link
Contributor

@mjago mjago commented May 22, 2017

Small changes to improve spec doc description

Copy link
Contributor

@RX14 RX14 left a comment

Choose a reason for hiding this comment

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

Overall looks great!

src/spec.cr Outdated
#
# Concrete test cases are defined with `it` within a `describe` block. A
# descriptive string is supplied to `it` describing what that test case
# Within a `describe` block concrete test cases are defined with `it` . A
Copy link
Contributor

Choose a reason for hiding this comment

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

Comma after block?

# tests specifically.
#
# Specs then use the `should` method to verify that the expected value is
# returned, see the example above for details.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not 100% on this change, maybe move the full stop before the brackets?

@mjago
Copy link
Contributor Author

mjago commented May 22, 2017

Thanks for suggestions 👍

@mverzilli mverzilli merged commit e270317 into crystal-lang:master May 26, 2017
@mverzilli
Copy link

This is great! Thank you @mjago ❤️

@mverzilli mverzilli added this to the Next milestone May 26, 2017
@mjago mjago deleted the spec_doc_grammer branch May 27, 2017 05:57
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.

None yet

3 participants