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

Document inaccuracy for worldParameters #2317

Open
laorient opened this issue Aug 30, 2023 · 1 comment
Open

Document inaccuracy for worldParameters #2317

laorient opened this issue Aug 30, 2023 · 1 comment
Labels
📖 documentation Improvements or additions to documentation ✅ accepted The core team has agreed that it is a good idea to fix this

Comments

@laorient
Copy link

👓 What did you see?

In doc/support_files/world.md, it describes putting worldParameters in config file using
{ worldParameters: { appUrl: 'http://localhost:3000/' } }
In reality, it should be under default:
{ default: { worldParameters: { appUrl: 'http://localhost:3000/' } }}

Otherwise, the config doesn't work.

✅ What did you expect to see?

Fix the documentation

📦 Which tool/library version are you using?

cucumber js 9.3.0

🔬 How could we reproduce it?

Just add a config file to a cucumber js project and try to print the value of the configured parameter at the start

📚 Any additional context?

None

@davidjgoss
Copy link
Contributor

Thanks for raising this @laorient. You're right that it's a bit confusing as it is. The reason we don't always include default is because that's the default profile and you can have other profiles, and also for config files in ES Module format that use named exports it wouldn't be applicable.

I'll try to come up with a pattern to express it more clearly and roll that out.

@davidjgoss davidjgoss added 📖 documentation Improvements or additions to documentation ✅ accepted The core team has agreed that it is a good idea to fix this labels Aug 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation ✅ accepted The core team has agreed that it is a good idea to fix this
Projects
None yet
Development

No branches or pull requests

2 participants