-
Notifications
You must be signed in to change notification settings - Fork 162
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 some documentation for memory_resource
#1217
Conversation
@harrism I cannot add you to the reviewers, so here a ping |
@jrhemstad can you change it so I can be added as a reviewer? |
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.
Please also wrap the lines of text at some reasonable column.
Otherwise, looking good other than a few points.
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.
praise: Wow, great docs with fantastic examples. I love the advice at the end.
suggestion: Since there is a lot in here, perhaps a TOC or some guide to the doc at the top would be useful?
question/suggestion: This is a great didactic document. But it is not an API reference. Is there an API reference to the concepts and refs?
nit: please correct the spelling of "documentation" in the PR title.
memory_resource
memory_resource
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.
I like the reorg. Just a few more suggestions.
Co-authored-by: Mark Harris <[email protected]>
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.
Looks good!
Co-authored-by: Mark Harris <[email protected]>
@griwes you are still marked as "changes requested" could you give this another look? |
Co-authored-by: Jake Hemstad <[email protected]>
Currently there is no documentation for our memory resource design.