Add libcuspatial C++ developer guide. #606
Conversation
|
rerun tests |
cpp/doc/DEVELOPER_GUIDE.md
Outdated
| All input and output iterators must be device-accessible with random access. They must satisfy the | ||
| requirements of C++ [LegacyRandomAccessIterator][LinkLRAI]. Output iterators must be mutable. | ||
|
|
||
| ## Multiple Return Values |
There was a problem hiding this comment.
Should this section go into the libcudf API section?
There was a problem hiding this comment.
It is useful for both APIs. Perhaps I should reiterate that the header-only API should return via output iterator where possible. However when the API needs to allocate the results, it must use return(s).
There was a problem hiding this comment.
I think it is confusing for me because you have grouped the libcudf and header only ## Multiple Return Values together, and you also seem to switch between the two frameworks while you talk about handling multiple return values. As a developer who is either interested in libcudf or interested in contributing to header only, I'd like a little more predictability about which paragraph is for me. This is a small detail though, mostly the document reads well, and I'm not asking you to change anything more.
There was a problem hiding this comment.
Thanks for the feedback. Let mesee what I can do.
There was a problem hiding this comment.
As a developer who is either interested in libcudf or interested in contributing to header only, I'd like a little more predictability about which paragraph is for me.
For what it's worth, I expect anyone contributing to libcuspatial will likely be contributing to both.
There was a problem hiding this comment.
OK, I found that I could clean this up by using parallel structure between the column-based and header-only API sections. I hope this makes it clearer for the reader.
Co-authored-by: H. Thomson Comer <[email protected]>
…l into doc-cpp-developer-guide
cpp/doc/DEVELOPER_GUIDE.md
Outdated
| All input and output iterators must be device-accessible with random access. They must satisfy the | ||
| requirements of C++ [LegacyRandomAccessIterator][LinkLRAI]. Output iterators must be mutable. | ||
|
|
||
| ## Multiple Return Values |
There was a problem hiding this comment.
I think it is confusing for me because you have grouped the libcudf and header only ## Multiple Return Values together, and you also seem to switch between the two frameworks while you talk about handling multiple return values. As a developer who is either interested in libcudf or interested in contributing to header only, I'd like a little more predictability about which paragraph is for me. This is a small detail though, mostly the document reads well, and I'm not asking you to change anything more.
|
rerun tests |
|
@gpucibot merge |
|
rerun tests |
Contributes to #598.
Adds a new libcuspatial C++ developer guide.