ARROW-12724: [C++][Docs] Add documentation for authoring compute kernels #13933
Conversation
drin
changed the title
|
Note that I plan on using a cookbook (apache/arrow-cookbook#227) to address most snippets and examples in the future. |
|
@github-actions crossbow submit preview-docs |
|
https://crossbow.voltrondata.com/pr_docs/13933/ once docs are built. |
|
@drin sorry for the spam. |
Co-authored-by: Benjamin Kietzman <[email protected]>
The "authoring compute kernels" docs was previously written in markdown. This commit begins the process of changing the format to reST. There are also some changes to make the organization and descriptions a bit more clear and/or concise.
With the exception of some URLs which are still in markdown, this commit addresses most comments left on the old PR. Most long lines were wrapped, most prose suggestions were taken, code format styles were changed from markdown to restructuredText. There was some discussion in certain areas that have not yet been addressed, but many of those will be addressed as I coalesce code snippets and descriptions with the cookbook.
To make the documentation a bit cleaner, I am trying to split the portions that explain the basic terminology and concepts of the compute layer into a separate document from the portions that try to describe code organization and best practices
drin
force-pushed
the
ARROW-12724-compute-docs
branch
from
e850b58
to
a0b0bc8
Compare
|
rebased for that sweet doc preview feature |
|
@github-actions crossbow submit preview-docs |
|
Revision: a0b0bc8 Submitted crossbow builds: ursacomputing/crossbow @ actions-53411d621c
|
|
I am still restructuring docs so this will need some iterations before final review, but it'll be cool to get initial feedback if the preview works |
|
Indeed. You'll need to re-run for each preview. |
|
This page is still a work in progress, but it's where I am thinking of putting some higher level overview of "the compute layer" (what are compute functions, what are function kinds, etc.) so that the author_compute_fn.html doc can be a bit leaner and more to the point. |
|
Sorry for orphan-ing this for so long. I would like to get back to this towards the end of the week. |
The goal of this PR is to update the existing documentation for authoring compute kernels.
This PR will primarily reformat the documentation from markdown into reStructured text and updated descriptions. In some cases, I will try to reference a cookbook.
This is a new PR against
apache/master, created as a rebase of the original PR (#10296) on top ofapache/masteras of 2022/08/20.