Skip to content

Move hints from test suites and stub solutions to HINTS.md #302

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

Closed
25 tasks done
rbasso opened this issue Sep 18, 2016 · 1 comment
Closed
25 tasks done

Move hints from test suites and stub solutions to HINTS.md #302

rbasso opened this issue Sep 18, 2016 · 1 comment

Comments

@rbasso
Copy link
Contributor

rbasso commented Sep 18, 2016

Currently we have some exercises with hints as comments in the test suite and/or in the stub solution.

Hints in the stub solutions are convenient - users are almost forced to read them - but proved to be a mess, because most users submit the code with the comments.

Hints in the test suite are not that bad, but they force the users to inspect it. I think that, ideally, users should get feedback running the tests, not studying them.

Anyway, considering that the contents of HINTS.md is automatically included in the README.md, it is the perfect place for hints. We just need to make it happen!

All the exercises that already have a HINTS.md file share the same formatting,

## Hints

so we are using this as a standard for now.

This issue will track the migration's progress as soon as we have a complete list of exercises to be changed.

Tracking changes

@rbasso
Copy link
Contributor Author

rbasso commented Sep 30, 2016

Hints' migration to HINTS.md files finished. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant