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.

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

Merged
merged 4 commits into from
Sep 21, 2021

Conversation

aslakhellesoy
Copy link
Contributor

@aslakhellesoy aslakhellesoy commented Sep 20, 2021

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:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.


| Argument | Description |
| ------------- | ----------- |
| `name` | The name the parameter type will be recognised by in output parameters.
Copy link
Contributor

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.)

Copy link
Contributor Author

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.

Copy link
Contributor

@olleolleolle olleolleolle left a 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.

@aurelien-reeves
Copy link
Contributor

What about moving Grammar and "Production rules* paragraphs elsewhere?
Those are far more technical, maybe in a CONTRIBUTING.md or ARCHITECTURE.md document?

@olleolleolle
Copy link
Contributor

Off-topic, but grammar-related: When this morning I visited the README, I wondered, "this grammar notation, what language is that written in?"

@mpkorstanje
Copy link
Contributor

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?

@aslakhellesoy
Copy link
Contributor Author

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>
@aslakhellesoy
Copy link
Contributor Author

Off-topic, but grammar-related: When this morning I visited the README, I wondered, "this grammar notation, what language is that written in?"

It’s pseudo-EBNF

@olleolleolle
Copy link
Contributor

Off-topic, but grammar-related: When this morning I visited the README, I wondered, "this grammar notation, what language is that written in?"

It’s pseudo-EBNF

Perfect. Then this makes it perhaps-more-legible: #10

@aslakhellesoy aslakhellesoy merged commit 0875a40 into main Sep 21, 2021
@luke-hill luke-hill deleted the document-cucumber-expressions branch September 1, 2023 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants