macropy icon indicating copy to clipboard operation
macropy copied to clipboard

Walker documentation partly outdated

Open Technologicat opened this issue 6 years ago • 1 comments

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 avatar Oct 02 '18 12:10 Technologicat

A cut at fixing this with minimal changes to the documentation is in https://github.com/Technologicat/macropy/commit/6abbdf87c935c7edc28aad6453a45d06dcfd3fd7

Technologicat avatar Oct 05 '18 22:10 Technologicat