Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Incorrect argument name 'cron_string' in cron jobs documentation example #2321

@sylvioCampos

Description

@sylvioCampos

Issue

There is an error in the python-rq documentation on the cron jobs page (https://python-rq.org/docs/cron/).

In the example given for the configuration file, the argument cron_string is used in the register function. However, the correct argument name should be cron.

Steps to reproduce

  • Go to https://python-rq.org/docs/cron/
  • Check the example for the configuration file.
  • Notice that cron_string is used instead of cron as the argument for the cron expression.

Expected behavior

The documentation should use the correct argument name cron in the example, so users can easily copy and use the configuration.

Suggested fix

Update the example in the documentation to use cron instead of cron_string in the register function.

I am opening this issue so I can submit a PR to fix the documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions