-
Notifications
You must be signed in to change notification settings - Fork 170
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
add docs for tree_utils module #724
add docs for tree_utils module #724
Conversation
this is great, thank you so much @amosyou ! Small request: instead of putting these in a new file docs/api/tree_utilities.rst, would you mind putting them in the file docs/api/general_utilities.rst and then rename that file to docs/api/utilities.rst ? We're trying to reduce the number of items under API documentation. |
sure thing @fabianp ! and then would it be cool if I also put the utilities for numerical stability and second order optimization in the utilities.rst? |
+100 that would be just perfect |
@fabianp combined everything into one utilities.rst, let me know if there's any other changes you'd see fit |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfection, thanks!!!
Thank you @amosyou ! A tiny little detail: could you order the Tree functions alphabetically? The rest of the doc is ordered that way, even though your order made sense too. Thanks again! |
sounds good @vroulet ! should we also reorder the types of util functions to be alphabetical (ie. general, numerical stability, second order, tree) or is the current ordering fine? |
Yes, let's be systematic. Thanks again! |
merged, thanks @amosyou ! |
Added documentation for tree utilities which fixes #685