Chore: Reorganize documentation and modules for vectors#5186
Merged
connortsui20 merged 3 commits intodevelopfrom Nov 4, 2025
Merged
Chore: Reorganize documentation and modules for vectors#5186connortsui20 merged 3 commits intodevelopfrom
connortsui20 merged 3 commits intodevelopfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>
Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>
Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>
6f59466 to
ffef105
Compare
gatesn
requested changes
Nov 4, 2025
Contributor
gatesn
left a comment
There was a problem hiding this comment.
I don't know why we would change the namespacing? Yeah there's a bunch of things, but it's finite and as you say, complete.
Contributor
Author
|
It's very difficult to understand what to look for when on the "landing" page docs. This way, it is obvious what is what (for example |
gatesn
approved these changes
Nov 4, 2025
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.
Tracking Issue: #5028
Now that we have basically all of the vectors (
Lists incoming later today), the crate namespace is getting super crowded. This PR removes the re-exporting into the crate level and makes all vectors accessible via the vortex-vector submodules. Additionally, this moves the main examples for each vector type into their respective modules (rather than on the mutable vector type directly).This is a purely cosmetic change that makes it easier to navigate the documentation of
vortex-vector. Given that this is effectively going to be Vortex's IR, I think it is important to be more careful about what we put into the top-level namespace.If people don't like having to type out an extra word when importing, then I would suggest we add a
preluderather than forcing everything at the top level.