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 of django_ready hook incorrectly lists "scenario" as a second positional argument #113

Open
LucidDan opened this issue Jul 26, 2020 · 2 comments
Labels

Comments

@LucidDan
Copy link

I started using behave-django today and ran fairly quickly into the issue that django_ready() hook is documented as taking a 'scenario' argument, but doesn't actually.

Can I suggest that you just update the documentation to correctly reflect the state of the project? While having scenario as an extra option might be useful, you should probably only make a change like that on a major version, or by adding a new additional hook function like django_scenario_ready(). In the meantime, the current version should have accurate documentation, especially for something people are likely to copy and paste in the first time they use the project (like I just did).

@bittner bittner added the docs label Aug 3, 2020
@bittner
Copy link
Member

bittner commented Aug 3, 2020

That one has popped up a few times since it was introduced with #46. Should be fixed now with commit 4d8df68. Sorry for the inconvenience. Not sure why this happened since not even the tests show the second argument.

Can you check the updated documentation and close this issue if the change is fine?

@bittner
Copy link
Member

bittner commented Oct 19, 2020

This is fixed in the current latest docs (stable is still showing the second argument in addition) and will be rolled out to stable with our next release to PyPI. 🏁

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

No branches or pull requests

2 participants