This repository was archived by the owner on Nov 30, 2024. It is now read-only.
Clarify @tag (cuke style) functionality in documentation #2573
Conversation
This file contains hidden or 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
JonRowe
reviewed
Oct 18, 2018
features/command_line/tag.feature
Outdated
| @@ -17,7 +17,8 @@ Feature: `--tag` option | |||
| `:name => 'bar'`. | |||
|
|
|||
| To be compatible with the Cucumber syntax, tags can optionally start with an | |||
| `@` symbol, which will be ignored. | |||
| `@` symbol, where the `@` symbol will be truncated when passed to the | |||
| configuration (`@focus` will be `:focus => true`). | |||
There was a problem hiding this comment.
How about:
`@` symbol, which will be ignored as part of the tag, e.g. `--tag @focus` is
treated the same as `--tag focus` which will then be expanded to (`:focus => true`).
There was a problem hiding this comment.
Sure, I think that works. Will change!
NickLaMuro
force-pushed
the
clarify-cucumber-tag-functionality
branch
from
99c4e51 to
11c9a43
Compare
|
@JonRowe Updated the wording from what you had slightly to allow it to fit nicely in an 80 character width 😄 . (I can keep what you had if you prefer, let me know) |
With the previous documentation, it was unclear if the passed in tag using the `@` (cucumber style tagging) would be ignored similar to doing `~tag` (for `--tag @tag`), or if it would "ignore" the `@` when building the configuration option (`@tag` changes to `:tag`). Looking at the implementation in `lib/rspec/core/option_parser.rb` confirms that it is the latter, so the wording has been updated to make that more clear.
NickLaMuro
force-pushed
the
clarify-cucumber-tag-functionality
branch
from
11c9a43 to
893b915
Compare
JonRowe
approved these changes
Oct 18, 2018
|
Thanks! |
MatheusRich
pushed a commit
to MatheusRich/rspec-core
that referenced
this pull request
Oct 30, 2020
With the previous documentation, it was unclear if the passed in tag using the `@` (cucumber style tagging) would be ignored similar to doing `~tag` (for `--tag @tag`), or if it would "ignore" the `@` when building the configuration option (`@tag` changes to `:tag`). Looking at the implementation in `lib/rspec/core/option_parser.rb` confirms that it is the latter, so the wording has been updated to make that more clear.
yujinakayama
pushed a commit
to yujinakayama/rspec-monorepo
that referenced
this pull request
Oct 6, 2021
With the previous documentation, it was unclear if the passed in tag using the `@` (cucumber style tagging) would be ignored similar to doing `~tag` (for `--tag @tag`), or if it would "ignore" the `@` when building the configuration option (`@tag` changes to `:tag`). Looking at the implementation in `lib/rspec/core/option_parser.rb` confirms that it is the latter, so the wording has been updated to make that more clear. --- This commit was imported from rspec/rspec-core@7288702.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
With the previous documentation, it was unclear if the passed in tag using the
@(cucumber style tagging) would be ignored similar to doing~tag(for--tag @tag), or if it would "ignore" the@when building the configuration option (@tagchanges to:tag).Looking at the implementation in
lib/rspec/core/option_parser.rbconfirms that it is the latter, so the wording has been updated to make that more clear.I was reading through this documentation myself recently, and was unsure when I read this what this did, so this is simply phrasing it in a way that made it more clear to me.
Open to suggestions for a better way to phrase this.