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.

Sign up for GitHub

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

Jump to bottom

Improve Javadoc for @CucumberOptions #338

Closed
aslakhellesoy opened this issue Jun 7, 2012 · 3 comments · Fixed by #1573
Closed

Improve Javadoc for @CucumberOptions #338

aslakhellesoy opened this issue Jun 7, 2012 · 3 comments · Fixed by #1573
Assignees
@mlvandijk
Labels
📖 documentation Improvements or additions to documentation good first issue Good for newcomers 🙏 help wanted Help wanted - not prioritized by core team

Comments

@aslakhellesoy
Copy link
Contributor

aslakhellesoy commented Jun 7, 2012 •
edited by mpkorstanje

The JavaDoc for @CucumberOptions should list the same info as the CLI's --help option.

The --help options are printed from USAGE.txt.
@aslakhellesoy
Copy link
Contributor Author

Also need to add JavaDoc to cucumber.api.cli.Main

@mlvandijk
Copy link
Member

When should the help options be listed when running from a runner with CucumberOptions?
It makes sense to type '--help' in the command line, where would you set/request it for CucumberOptions?

@stale stale bot added the ⌛ stale Will soon be closed by stalebot unless there is activity label Dec 25, 2017
@stale stale bot closed this as completed Jan 1, 2018
@lock lock bot locked as resolved and limited conversation to collaborators Jan 1, 2019
@mpkorstanje mpkorstanje added the good first issue Good for newcomers label Jan 1, 2019
@mpkorstanje mpkorstanje changed the title CLI like Javadoc for @Cucumber.Options Improve Javadoc for @CucumberOptions Jan 1, 2019
@mpkorstanje mpkorstanje added 🙏 help wanted Help wanted - not prioritized by core team and removed ⌛ stale Will soon be closed by stalebot unless there is activity labels Jan 1, 2019
@cucumber cucumber deleted a comment from stale bot Jan 1, 2019
@cucumber cucumber deleted a comment from stale bot Jan 1, 2019
@cucumber cucumber deleted a comment from lock bot Jan 1, 2019
@mpkorstanje
Copy link
Contributor

mpkorstanje commented Jan 1, 2019 •
edited

@mlvandijk the options should be described in the Javadoc for @CucumberOptions in addition to the CLI. The current Javadoc is rather sparse. This should remove the need to print --help in the first place.

https://github.com/cucumber/cucumber-jvm/blob/v4.2.0/core/src/main/java/cucumber/api/CucumberOptions.java

@mlvandijk mlvandijk reopened this Jan 1, 2019
@mlvandijk mlvandijk self-assigned this Jan 1, 2019
mpkorstanje added a commit that referenced this issue Mar 4, 2019
@mpkorstanje
[Core] Improve documentation
717ec9e 
Fixes: #338
mpkorstanje added a commit that referenced this issue Mar 6, 2019
@mpkorstanje
[Core] Improve documentation
18b0640 
Fixes: #338
mpkorstanje added a commit that referenced this issue Mar 6, 2019
@mpkorstanje
[Core] Improve documentation
9c52639 
Fixes: #338
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@mlvandijk mlvandijk

Labels
📖 documentation Improvements or additions to documentation good first issue Good for newcomers 🙏 help wanted Help wanted - not prioritized by core team
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Core] Improve CucumberOptions documentation cucumber/cucumber-jvm
3 participants
@aslakhellesoy @mpkorstanje @mlvandijk