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

Update "tube" document to reflect API #84

Open
jMyles opened this issue Feb 26, 2019 · 0 comments
Open

Update "tube" document to reflect API #84

jMyles opened this issue Feb 26, 2019 · 0 comments

Comments

@jMyles
Copy link
Contributor

jMyles commented Feb 26, 2019

@glyph points out in #82 that the docs are out-of-date insofar as linesToNumbersOrOperators is shown as being decorated @tube, but not @receiver.

On master, in docs/listings/rpn.py, linesToNumbersOrOperators is indeed shown as decorated @receiver(inputType=IFrame). In addition, tube.rst has :prepend: @tube in the entry for this include.

I have built the docs myself locally and the entry appears this way:

@tube
@receiver(inputType=IFrame)
def linesToNumbersOrOperators(line):
    from operator import add, mul
    try:
        yield int(line)
    except ValueError:
        if line == b'+':
            yield add
        elif line == b'*':
            yield mul

So, two questions:

  1. How is it supposed to read? With only the @receiver decorator? Or the @tube decorator as well?

  2. Any idea why the RTFD is out of date with master? Can I help get that on track?

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