fixed: typo in example of "retryTo" in lib/effects.js

[danielrentz]

Motivation/Description of the PR

• fixed typo in @example documentation of effects/retryTo

Applicable helpers:

• Playwright
• Puppeteer
• WebDriver
• REST
• FileHelper
• Appium
• TestCafe

Applicable plugins:

• allure
• autoDelay
• autoLogin
• customLocator
• pauseOnFail
• coverage
• retryFailedStep
• screenshotOnFail
• selenoid
• stepByStepReport
• stepTimeout
• wdio
• subtitles

Type of change

• 🔥 Breaking changes
• 🚀 New functionality
• 🐛 Bug fix
• 🧹 Chore
• 📋 Documentation changes/updates
• ♨️ Hot fix
• 🔨 Markdown files fix - not related to source code
• 💅 Polish code

Checklist:

• Tests have been added
• Documentation has been added (Run npm run docs)
• Lint checking (Run npm run lint)
• Local tests are passed (Run npm test)

[kobenguyent]

@danielrentz may you please run this to make sure the docs are updated as well?

• Documentation has been added (Run npm run docs)

[Copilot]

Pull Request Overview

This PR fixes a typo in the JSDoc example documentation for the retryTo function in lib/effects.js. The example was incorrectly importing hopeThat instead of retryTo.

• Corrected the import statement in the @example documentation to properly reference retryTo

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[danielrentz]

@kobenguyent
This is my experience with running the scripts suggested in CONTRIBUTING.md:

Documentation

> npm install
...
> npm run docs
...
./codeceptjs/runok.js:339
    for (const method of webdriverDoc[0].members.instance) {
                                         ^
TypeError: Cannot read properties of undefined (reading 'members')
    at Object.docsAppium (./codeceptjs/runok.js:339:42)
    at async Object.docsHelpers (./codeceptjs/runok.js:245:9)
    at async Promise.all (index 0)
    at async Object.docs (./codeceptjs/runok.js:29:5)

leaves a locally modified docs/helpers/Appium.md.

Typings

> npm run def

does not modify anything.

Now, running "docs" again will succeed.

> npm run docs
...
> git status

leaves a locally modified docs/plugins.md with obviously unrelated changes. Appium.md returned to original state.

Btw, the exception in the initial "docs" script seems to happen only in a freshly cloned repository, later runs will succeed, even after resetting all changed files.

Testing

> mocha test/unit
bash: mocha: command not found

Seems the CONTRIBUTING.md file needs some updates.

The PR checklist suggests npm test instead:

> npm test

gives weird console outputs such as

[object Object]]     [140]  Starting recording promises

and failing tests such as

  1) MochawesomeHelper with retries
       "before each" hook for "should add context to the correct test object when test is retried":
     Error: Cannot find module 'mochawesome/addContext'
Require stack:
- ./codeceptjs/lib/helper/Mochawesome.js

Conclusion

The initial change in this PR does not lead to any documentation updates. Seems the documentation for the effects functions (docs/effects.md) has been created manually, and contains different example code.

Do you want me to commit the updated docs/plugins.md with this PR?

[kobenguyent]

The initial change in this PR does not lead to any documentation updates. Seems the documentation for the effects functions (docs/effects.md) has been created manually, and contains different example code.

@danielrentz thanks! then all good.