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

add docstrings #1

Open
mattjj opened this issue Jan 30, 2018 · 2 comments
Open

add docstrings #1

mattjj opened this issue Jan 30, 2018 · 2 comments
Assignees
@mattjj

Comments

@mattjj
Copy link
Owner

mattjj commented Jan 30, 2018

Docstrings for some key functions and data structures, especially Node and Box, might help. Any suggestions for specific places to add docstrings?
@mattjj mattjj self-assigned this Jan 30, 2018
@dustinvtran
Copy link

dustinvtran commented Jan 31, 2018 •
edited
Loading

One that came up today: subvals. Reading through it, I guess it stands for "substitute values"?

In general, some of the shorthand can be difficult to trace (no pun intended).

@dustinvtran
Copy link

Another is primitive, which wraps f_raw followed by wraps which wraps f_wrapped and is parameterized by f_raw. It's not clear why there's nested decorators until you read and grok all the logic.

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

@mattjj mattjj

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mattjj @dustinvtran