Skip to content

Chore: Reorganize documentation and modules for vectors#5186

Merged
connortsui20 merged 3 commits intodevelopfrom
ct/vector-prettyify
Nov 4, 2025
Merged

Chore: Reorganize documentation and modules for vectors#5186
connortsui20 merged 3 commits intodevelopfrom
ct/vector-prettyify

Conversation

@connortsui20
Copy link
Copy Markdown
Contributor

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 prelude rather than forcing everything at the top level.

@connortsui20 connortsui20 requested review from a10y and gatesn November 4, 2025 15:49
@connortsui20 connortsui20 added the changelog/chore A trivial change label Nov 4, 2025
connortsui20 added a commit that referenced this pull request Nov 4, 2025
Tracking Issue: #5028

Note that I'm probably going to move where this is placed in the next
[PR](#5186) but the content
will be the same.

Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>
Base automatically changed from ct/decimal-tests to develop November 4, 2025 15:57
@codecov
Copy link
Copy Markdown

codecov bot commented Nov 4, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.05%. Comparing base (784bad9) to head (ffef105).
⚠️ Report is 2 commits behind head on develop.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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>
Copy link
Copy Markdown
Contributor

@gatesn gatesn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@connortsui20
Copy link
Copy Markdown
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 Vector is the top-level type and everything else is a variant of it, if you have 20+ types all in the same place there is no chance you will understand that)

@connortsui20 connortsui20 requested a review from gatesn November 4, 2025 18:19
@connortsui20 connortsui20 merged commit d2272a3 into develop Nov 4, 2025
41 checks passed
@connortsui20 connortsui20 deleted the ct/vector-prettyify branch November 4, 2025 18:22
@connortsui20 connortsui20 mentioned this pull request Nov 4, 2025
39 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/chore A trivial change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants