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

Annotations and tests should find each other when searching #3

Open
seebees opened this issue Jun 11, 2021 · 0 comments
Open

Annotations and tests should find each other when searching #3

seebees opened this issue Jun 11, 2021 · 0 comments

Comments

@seebees
Copy link
Contributor

seebees commented Jun 11, 2021

Given an annotation in code like this

//= master_key_spec.txt#2.1
//# On initialization, the caller MUST provide:
//# *  An AWS KMS key identifier
//# *  An AWS KMS SDK client

Currently the test looks like this

//= master_key_spec.txt#2.1
//= type=test
//# On initialization, the caller MUST provide:
//# *  An AWS KMS key identifier
//# *  An AWS KMS SDK client

However, this means when searching for the test from the code
or the code from the test using a simple search,
the //= type=test line needs to be added or removed.

I suggest changing this to place the optional type
at the end of the annotation.
Like this

//= master_key_spec.txt#2.1
//# On initialization, the caller MUST provide:
//# *  An AWS KMS key identifier
//# *  An AWS KMS SDK client
//= type=test

Another option would be to append the requirement number to spec reference.
So this would be the 5th requirement in the section:

//= master_key_spec.txt#2.1&n=5
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