Add or more prominently link to documentation for `step.retry()`

Open Beginner friendly
#4,958 10 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript
Domain
documentation

Research direction

Start with the retrying documentation at codecept.io/basics/#retries and compare it with the deprecation warning source in lib/actor.js around line 61. Document step.retry() or make the existing guidance easier to find, replacing the outdated I.retry() usage, then verify the page clearly explains the supported API.

Written by the indexing model from the issue text.

Description

stale

During normal usage of codeceptjs@3.7.2 I see the following repeated warning:

I.retry() is deprecated, use step.retry() instead

This comes from here, naturally.

Unfortunately I am unable to find any documentation of what step.retry() is or how to use it?

Image

and

Image

The documentation for retrying still uses I.retry() throughout:

Image

Could you please add documentation for step.retry(), or if the documentation exists, could you please make it easier to find.

Dominant language
JavaScript
Stars
4.2k
Forks
756
Avg merge
2d 9h
Merged PRs (30d)
16

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from codeceptjs/CodeceptJS

All issues in codeceptjs/CodeceptJS

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.