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

better documentation #41

Open
rogpeppe opened this issue Oct 26, 2017 · 2 comments
Open

better documentation #41

rogpeppe opened this issue Oct 26, 2017 · 2 comments

Comments

@rogpeppe
Copy link
Contributor

Very few of the types and methods in pymacaroons have documentation. This is problematic, because it's not always clear what types the arguments are expected to be or what the methods do. For example, the caveat_id member of the public Caveat type is expected to be an instance of bytes (I think), but it's not clear that is the case.

@BigSamu
Copy link

BigSamu commented Dec 12, 2021

Support this query. Would be great to have a more detailed documentation if possible

@miketheman
Copy link

Thinking about type hints, the currently advertised support for Python versions would have to be narrowed to support the right kinds of type hints.

Specifically, Python 2.7-3.7 are all unsupported versions of Python - should those version support be removed so newer syntax and type hints can be added?

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

3 participants