Document tags field
#468
Merged
Document tags field
#468
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
ErikSchierboom
commented
Oct 6, 2023
ErikSchierboom
commented
- Add tags to analyzer interface
- More tags
- Add more tag usage
- Add more documentation
- Update linting rules
|
Closes #467? |
ee7
reviewed
Oct 6, 2023
ee7
reviewed
Oct 6, 2023
ee7
reviewed
Oct 6, 2023
building/configlet/lint.md
Outdated
Comment on lines
594
to
599
| 7. **Valid `tag`**: A non-blank string¹ that is formatted as `<category>:<thing>`, with `<category>` must be one of the following values: | ||
|
|
||
| - `paradigm` (e.g. `paradigm:functional`) | ||
| - `technique` (e.g. `technique:recursion`) | ||
| - `construct` (e.g. `construct:bitwise-and`) | ||
| - `uses` (e.g. `uses:DateTime.add_seconds`) |
There was a problem hiding this comment.
Should there be a rule for the value of <thing>? For example, length greater than 0, and characters in `{'0'..'9', 'A'..'Z', 'a'..'z', '-', '_', '.'}?
There was a problem hiding this comment.
And maybe we could say "analyzer tag" or something, to help disambiguate from the existing tags?
ee7
reviewed
Oct 6, 2023
building/configlet/lint.md
Outdated
|
|
||
| - `paradigm` (e.g. `paradigm:functional`) | ||
| - `technique` (e.g. `technique:recursion`) | ||
| - `construct` (e.g. `construct:bitwise-and`) | ||
| - `uses` (e.g. `uses:DateTime.add_seconds`) | ||
|
|
||
| The `<thing>` value must a string that contains only characters in the range `[a-z0-9]`, optionally separated by dashes (e.g. `"two-fer"`) or underscores (e.g. `"two_fer"`). It must match the regular expression: `^[a-z0-9]+([-_][a-z0-9]+)*$` |
There was a problem hiding this comment.
Maybe "by a single dash" and "or by a single underscore"?
And the above example of DateTime.add_seconds does not match that regular expression - there is a ., and a capital letter.
There was a problem hiding this comment.
Hmmm, let's just make it non-blank, as tracks are free to use them how they please
ErikSchierboom
force-pushed
the
add-tags-documentation
branch
from
c69e1bf to
def3a37
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.