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

Documentation: Add Link to wdio-ics:options.logName For formatImageName #729

Open
2 of 5 tasks
htho opened this issue Jan 16, 2025 · 1 comment
Open
2 of 5 tasks

Comments

@htho
Copy link

htho commented Jan 16, 2025

Pre-check

Describe the improvement

I'd like to report

  • Unclear documentation
  • A typo
  • Missing documentation
  • Other

Description of the improvement / report

I created a repository where I tried to reproduce the problems I found, when setting up visual testing: https://github.com/htho/wdio-repro-visual-service

The formatImageName configuration is good, but the documentation for the logName should be improved.
If you did not see that there is the wdio-ics:options.logName in the overview, you would not know that it exists, and you can only guess where that variable comes from.

There should be a link to the/a documentation for wdio-ics:options.logName.

Here is my config for reference: https://github.com/htho/wdio-repro-visual-service/blob/main/wdio-formatImageName.conf.ts#L21

@wswebcreation
Copy link
Member

Hi @htho

Thanks for submitting this issue. Are you able to create a PR for this? Help is much appreciated , you can start by adjusting this file https://github.com/webdriverio/webdriverio/blob/main/website/docs/VisualTesting.md by adding the wdio-ics:options there

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants