Skip to content

documentation: README.md conventions corrections. #1010

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
Insti opened this issue Nov 15, 2017 · 2 comments
Closed

documentation: README.md conventions corrections. #1010

Insti opened this issue Nov 15, 2017 · 2 comments

Comments

@Insti
Copy link
Contributor

Insti commented Nov 15, 2017

The README.md test data format section has some issues that need fixing.

Task

Update the "There are also some convention about expected that you must follow:" section of README.md

Suggested changes:

There are also some conventions about expected that you must follow:

All keys should follow the lowerCamelCase convention.
If the input is valid but there is no result for the input, the value at "expected" should be null.
If an error is expected (because the input is invalid, or any other reason), the value at "expected" should be an object containing exactly one property, "error", whose value is a string.
The string should explain why the error would occur.
A particular track's implementation of the exercise need not necessarily check that the error includes that exact string as the cause, depending on what is idiomatic in the language (it may not be idiomatic to check strings for error messages).

There may be other changes that need making within that section, these were just the ones that caused me to create the issue.

(The bullet points should probably stay, they just disappeared when I copy/pasted the text.)

See also: #1009

@Insti Insti changed the title Documentation: README.md conventions corrections. documentation: README.md conventions corrections. Nov 15, 2017
@rpottsoh rpottsoh self-assigned this Nov 16, 2017
@rpottsoh
Copy link
Member

@Insti, according to the README the canonical data is considered optional (about line 33 I think). Since the desire is for every exercise to have canonical data present should the optional call out be removed from this document?

I am working on the revisions you brought up when you opened this issue.

@Insti
Copy link
Contributor Author

Insti commented Nov 16, 2017

should the optional call out be removed from this document?

Yes, that sounds sensible.

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

No branches or pull requests

2 participants