usage of the --path option (and other valid ember test options) needs clarification
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 62/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- cli, documentation
Research direction
Start with the randomization documentation at ember-cli.github.io/ember-exam/docs/randomization and the README section linked in the issue; compare its options list with yarn run ember exam --help. Update the documentation to state that ember exam accepts the other ember test options, including --path, and make the supported CLI scope clear.
Written by the indexing model from the issue text.
Description
when I read the docs I thought that --path option is only valid with the exam:iterate command.
https://github.com/ember-cli/ember-exam#randomization-iterator
It was not easy for me to understand that --path is also valid with the exam command also. The readme has the below quote regarding the ember test inheritance.
Using Ember Exam is fairly straightforward as it extends directly from the default Ember-CLI test command. So, by default, it will work exactly the same as ember test.
After running yarn run ember exam --help, valid options were more clear to me. But seeing the path option only for the exam:iterate mislead me initially. I believe that explicitly stating that all the other ember test options are also valid for ember exam on the docs site and/or README could be beneficial. When I visit the docs site and see the options section, I immediately think that these are the only valid CLI options, there is nothing more.
https://ember-cli.github.io/ember-exam/docs/randomization
- Dominant language
- JavaScript
- Stars
- 289
- Forks
- 65
- Avg merge
- 4m
- Merged PRs (30d)
- 9
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ember-cli/ember-exam
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ember-cli/ember-exam#1513 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
ember-cli/ember-exam#1514 · 2 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
ember-cli/ember-exam#1296 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
ember-cli/ember-exam#1055 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
ember-cli/ember-exam#1009 · 3 comments ·
All issues in ember-cli/ember-exam
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
[Block] Latest Posts [Type] Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·