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

Docs: User step should be When #1159

Open
justin-taylor-ics opened this issue Feb 1, 2024 · 1 comment
Open

Docs: User step should be When #1159

justin-taylor-ics opened this issue Feb 1, 2024 · 1 comment

Comments

@justin-taylor-ics
Copy link

In the Tutorial, under Step Parameters there are two example scenarios. I believe the Given in each should be changed to When since the step is a user action.

Scenario: look up a book
      When I search for a valid book
      Then the result page will include "success"

Scenario: look up an invalid book
      When I search for a invalid book
      Then the result page will include "failure"

FWIW - I attempted to make this simple change to the documentation following the contribution guidelines, but Sphinx (which I am not familiar with) threw this error:

invoke docs
sphinx-build -b html -D language=en . ../build/docs/html/en
Running Sphinx v4.3.2
USE SPHINX-INTL: locale_dirs=locale/
loading translations [en]... done

Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.

@jenisys
Copy link
Member

jenisys commented Feb 3, 2024

This is a problem that was introduced by sphinxcontrib-applehelp.
I pushed a commit that should resolve the problem.

$ pip install -U -r py.requirements/docs.txt
$ invoke docs
# OR: tox -e docs

SEE ALSO:

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

No branches or pull requests

2 participants