Expanding conceptual docs (and some other minor docs)#8552
Merged
Conversation
Merging this PR will not alter performance
|
| Mode | Benchmark | BASE |
HEAD |
Efficiency | |
|---|---|---|---|---|---|
| ❌ | Simulation | chunked_varbinview_into_canonical[(1000, 10)] |
168.9 µs | 205.6 µs | -17.85% |
| ❌ | Simulation | slice_empty_vortex |
310 ns | 368.3 ns | -15.84% |
| ❌ | Simulation | rebuild_naive |
99.8 µs | 111 µs | -10.09% |
| ⚡ | Simulation | chunked_bool_canonical_into[(1000, 10)] |
27 µs | 16.1 µs | +67.45% |
| ⚡ | Simulation | chunked_varbinview_canonical_into[(100, 100)] |
258.9 µs | 223.7 µs | +15.71% |
| ⚡ | Simulation | bitwise_not_vortex_buffer_mut[128] |
244.4 ns | 215.3 ns | +13.55% |
| ⚡ | Simulation | chunked_varbinview_into_canonical[(100, 100)] |
306 µs | 270.8 µs | +13.01% |
| ⚡ | Simulation | bitwise_not_vortex_buffer_mut[1024] |
304.7 ns | 275.6 ns | +10.58% |
Tip
Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.
Comparing adamg/expands-rustdocs-from-docs (6a08e69) with develop (226477d)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds more docs, both module level conceptual docs which pulls from
docs/, and many local changes documenting specific functions or types. Also tried to include basic examples.The main changes are in
vortex,vortex-arrayandvortex-fileandvortex-layout.Was done with the help of Claude to try and find gaps/mistakes, and fill in some of the obvious changes.