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

Walker documentation partly outdated #8

Open
Technologicat opened this issue Oct 2, 2018 · 1 comment
Open

Walker documentation partly outdated #8

Technologicat opened this issue Oct 2, 2018 · 1 comment

Comments

@Technologicat
Copy link

The documentation and docstrings of Walker need updating:

  • ctx is passed by name, not positionally.
  • ctx is just an arbitrary user-defined name; it has no special meaning. This is essentially a mechanism to pass in arbitrary named arguments that will be propagated following the rules explained in the documentation.
  • Some up-to-date usage examples with one and two ctx items would make the documentation easier to understand.

I could take a look at this and perhaps submit a PR later.

@Technologicat
Copy link
Author

A cut at fixing this with minimal changes to the documentation is in Technologicat@6abbdf8

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

1 participant