Skip to content

README.md doesn't describe optional tests #342

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
karenetheridge opened this issue Apr 25, 2020 · 1 comment
Closed

README.md doesn't describe optional tests #342

karenetheridge opened this issue Apr 25, 2020 · 1 comment

Comments

@karenetheridge
Copy link
Member

If you look inside the draft directory, there are a number of .json files,
which logically group a set of test cases together. Often the grouping is by
property under test, but not always, especially within optional test files
(discussed below).

...only there is no discussion below.

This paragraph was introduced in commit 9cda89e way back in 2012, but no description of the optional/ directory was added.

A simple paragraph should be enough -- something like "Tests in the optional/ directory should not be run automatically. They describe behaviour that may be implemented in accordance with section 5 of RFC2119 [that's the definition of "MAY"]" perhaps?

In my code that wraps around the test suite, I intend to run these tests only if include_optional = 1 was included as an option.

@Julian
Copy link
Member

Julian commented Apr 25, 2020

Thanks! I agree, but this is #25

A PR would of course be more than welcome!

@Julian Julian closed this as completed Apr 25, 2020
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

2 participants