Simplify documentation about tags #842
Labels
Component: Docs
Priority: Medium
Wrong or misleading documentation, broken behavior with workaround
Size: Medium
Changes in the same file
Type: Enhancement
Is your feature request related to a problem? Please describe.
As a reader, I find it very difficult to grasp how to name and use tags and if there is any special handling required reading this docs page Documentation about tagging tests
Other frameworks (like PHPUnit) allow to provide tags in a form of
@mytag
. Bats has it is unique way, which is probably driven by some technical challenges, and it understandable. But the documentation is written in a such way that a reader need to read the whole page to understand how to use the tagging feature, and even after that - it is still not clear on some specifics.Is
tag:
intag:1
a special keyword? Should my tags start withtag:
? If not - can it be justmytag
? (It can!) What is the significance of the colon:
?No example for
bats:focus
Should I write it as
# bats test_tags=bats:focus
? or# bats bats:focus
or# bats:focus
?No example of multiline tags. Can I do this?
Should it be
bats --filter-tags mytag
orbats --filter-tags mytag path/to/file
Describe the solution you'd like
tag:1
ora:b
.Describe alternatives you've considered
N/A
Additional context
I've been using bats for 5 years and still forget this syntax. I can only imagine how people using Bats occasionally gets confused by these docs.
The text was updated successfully, but these errors were encountered: