Improve public API docs and expand the manual.#708
Conversation
Add missing docstrings for backends, kernel handles, and reflection macros; expand quickstart, kernels, and API pages with examples. Co-authored-by: Cursor <cursoragent@cursor.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #708 +/- ##
==========================================
+ Coverage 52.31% 52.39% +0.08%
==========================================
Files 22 22
Lines 1688 1691 +3
==========================================
+ Hits 883 886 +3
Misses 805 805 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
I added a step to the docs CI job to always upload the docs build as an artefact, so that can be always inspected also when preview isn't available. For the latest version of the docs you can find the build at https://github.com/JuliaGPU/KernelAbstractions.jl/actions/runs/27298019329/artifacts/7544902664. |
Clarify in the kernels guide that local memory allocation sizes must be known at compile time. Co-authored-by: Cursor <cursoragent@cursor.com>
Suggested-by: Christian Guinard <28689358+christiangnrd@users.noreply.github.com>
Suggested-by: Christian Guinard <28689358+christiangnrd@users.noreply.github.com>
|
I turned most codeblocks in "Quickstart" and "Writing kernels" into proper doctests and runnable examples, to make sure they actually work correctly, otherwise there's the risk they'll bitrot. The doctest CI job hasn't been doing anything so far, as there currently are no doctests |
Co-authored-by: Christian Guinard <28689358+christiangnrd@users.noreply.github.com>
…ction Also, make it crystal clear that internals are not meant to be directly used by end-users.
|
Ok, I should have addressed all comments above (I hope I didn't miss any!). The added doctests/ |
3 participants
Add missing docstrings for backends, kernel handles, and reflection macros; expand quickstart, kernels, and API pages with examples.
Mostly made by Cursor, I haven't reviewed all changes in detail (also because there are some areas I'm not familiar with), so please review everything very carefully!