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.

Sign up for GitHub

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

Jump to bottom

document has_units #36

Open

bnordgren opened this issue Sep 22, 2014 · 0 comments

bnordgren commented Sep 22, 2014

Documentation for has_units is missing (a blank section has been stubbed out for it).

Contents of this section should:

describe how the function should appear to clients
describe how the decorator alters the function arguments
describe how the return value is altered before it is passed to the caller
provide an example function which makes explicit all of the above by showing an equivalent function with all the wrapper code included.
give example of how (or if?) one can return a tuple of unitted values from a unitted function

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment