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.

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

Docs for Length module? #63

Closed
smheidrich opened this issue Mar 1, 2017 · 2 comments
Closed

Docs for Length module? #63

smheidrich opened this issue Mar 1, 2017 · 2 comments

Comments

@smheidrich
Copy link
Contributor

Why isn't there any documentation for the BTrees.Length.Length class? Is that because it doesn't have an interface and the documentation is supposed to contain only interfaces? Is Length even an official part of BTrees if it's undocumented? It is mentioned in the ZODB docs, that's why I'm wondering...
@tseaver
Copy link
Member

tseaver commented Mar 2, 2017

@smheidrich Nothing so intentional: It is just an oversight. Please feel free to submit a PR adding a new "utilities" section to https://raw.githubusercontent.com/zopefoundation/BTrees/master/docs/api.rst, using the autoclass directive to pull in Length.

@smheidrich smheidrich mentioned this issue Mar 5, 2017
Merged
@tseaver
Copy link
Member

tseaver commented Mar 5, 2017

Via #64.

@tseaver tseaver closed this as completed Mar 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tseaver @smheidrich