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

Add version, tags fields to script, tests #27

Merged
merged 3 commits into from
Jun 16, 2020
Merged

Add version, tags fields to script, tests #27

merged 3 commits into from
Jun 16, 2020

Conversation

bdarcus
Copy link
Member

@bdarcus bdarcus commented Jun 13, 2020

Partially addresses #17 and #25, this adds "VERSION" and "TAGS' fields to the
processor.py script, and to the former to all the tests.

It doesn't currently do much with the output, other than to add "version" and "tags" variables to the json test files, but the idea is we could do two things with this:

  1. distinguish 1.0 and 1.1 tests (though we need to figure out how to address this suggestion on min and max version; maybe simply 1.0-1.1?)
  2. tag tests that we think need documentation in the spec (which would be the next step); perhaps like docfix?

Below I note @fbennett agrees we could also use "description" field. I suggest people just start adding that when they see a need for it on a test. The script will simply ignore it currently.

My suggestion on 2, then: on those tests that we think expose a gap in the spec, we simply add the docfix tag above, along with a description field (which the script will ignore) if it would be helpful to understand why you tagged it. Beyond that, I don't know what other tags would be relevant here, but we should aim to develop a controlled list, so easy to work with the results.

Partially addresses #17 and #25, this adds a "VERSION" field to the
processor.py script.

Syntax for the field value is: [version]:[tag].
@bdarcus bdarcus requested a review from fbennett June 13, 2020 21:53
@bdarcus
Copy link
Member Author

bdarcus commented Jun 13, 2020

Does this make sense @fbennett @adam3smith?

@bdarcus

This comment has been minimized.

@bdarcus bdarcus changed the title Add version field to processor.py Add version field to processor.py, tests Jun 13, 2020
@bdarcus
Copy link
Member Author

bdarcus commented Jun 14, 2020

In this comment, @fbennett expresses support for also tags and description field, and possibly YAML.

I think the latter should be the longer term goal for the test suite, perhaps borrowing ideas and/or code from jest-csl, but that it's not urgent now, and I'm not the person to do this.

This step would allow for that more extensive refactor later, though.

If you approve, @adam3smith, just merge it?

This field would be used to filter tests. Althought currently this value
will convert to a string, assuming comma-separated tokens.
@bdarcus bdarcus changed the title Add version field to processor.py, tests Add version, tag fields to processor.py, tests Jun 14, 2020
@bdarcus bdarcus changed the title Add version, tag fields to processor.py, tests Add version, tags fields to script, tests Jun 14, 2020
@bdarcus bdarcus requested a review from adam3smith June 14, 2020 16:13
@bdarcus bdarcus merged commit 4c1e0b6 into master Jun 16, 2020
@bdarcus bdarcus deleted the add-section branch June 16, 2020 11:32
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.

1 participant