-
-
Notifications
You must be signed in to change notification settings - Fork 52
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.
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
Move documentation from the docs repo #3
Conversation
|
||
| Argument | Description | | ||
| ------------- | ----------- | | ||
| `name` | The name the parameter type will be recognised by in output parameters. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we using American or British English as our target language? (US color+recognize vs UK colour+recognise.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think British English is the predominant language used in our docs, but I’m sure there are many inconsistencies.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is such a good idea.
What about moving Grammar and "Production rules* paragraphs elsewhere? |
Off-topic, but grammar-related: When this morning I visited the README, I wondered, "this grammar notation, what language is that written in?" |
Parts of this documentation - specifically the how-to-do-in-language-x - aren't quite part of this cucumber expressions module. The module only provides a registry. Would it be an idea to link to the relevant sections in the Cucumber implementation read me's for those parts? |
I had the same thought @mpkorstanje and decided to leave here for now since some of the cucumber implementations don’t (yet) have a github markdown page we can link to. I’d prefer to do that in a second pass, which would involve creating a ticket in all the relevant repos, and wait for these tickets to be resolved. |
Co-authored-by: Aurélien Reeves <aurelien.reeves@smartbear.com>
It’s pseudo-EBNF |
Description
Document Cucumber Expressions in the same repo where their implementation lives.
Motivation & context
Update required of cucumber.io/docs
Ref: cucumber/docs#667
Checklist: