docs: document version checkout via lance_dataset_open#19
Merged
jja725 merged 1 commit intolance-format:mainfrom Apr 27, 2026
Merged
docs: document version checkout via lance_dataset_open#19jja725 merged 1 commit intolance-format:mainfrom
jja725 merged 1 commit intolance-format:mainfrom
Conversation
lance_dataset_open already takes a version argument — 0 for latest, any other id for that specific version — but the capability wasn't obvious from the existing docstrings. This adds an inline example to the C header and C++ wrapper, and a short "Open at a specific version" section to the README so checkout is discoverable without reading the source. No ABI or code changes. Closes lance-format#13.
jja725
reviewed
Apr 24, 2026
Collaborator
jja725
left a comment
jja725
left a comment
There was a problem hiding this comment.
LGTM. Docs-only — README example matches the C/C++ docstrings, version sentinel (0 = latest) is consistent with the existing lance_dataset_open signature.
jja725
approved these changes
Apr 27, 2026
2 tasks
jja725
added a commit
that referenced
this pull request
Apr 28, 2026
## Summary Bring the README roadmap in line with what actually shipped on `main`: - Fix the **header path links** at the top — `include/lance.h` / `include/lance.hpp` 404'd after #26 (Phase 4 packaging) moved the headers under `include/lance/`. - **Phase 3 → Dataset write**: flip `[ ]` → `[x]` (`lance_dataset_write` from #16, `lance_dataset_write_with_params` from #20). - **Phase 3 → Version management**: flip `[ ]` → `[x]` — list (`lance_dataset_versions`, #18), rollback (`lance_dataset_restore`, #18), and version checkout (`lance_dataset_open(uri, opts, version)`, documented in #19). - **Additional features**: add `Substrait filter pushdown` row pointing at `lance_scanner_set_substrait_filter` (#25). No source changes; docs only. ## Test plan - [x] Markdown renders correctly (links resolve to `include/lance/lance.h` and `include/lance/lance.hpp`) - [x] `git diff origin/main` shows only the four targeted edits
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
2 participants
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
lance_dataset_open's C and C++ docstringsMotivation
lance_dataset_openalready takes aversionargument (0 = latest, otherwise the specific version id), but it was buried in the parameter list and easy to miss. Withlance_dataset_versions(#17) now available, time-travel is a two-line recipe — this makes that recipe discoverable without reading the source.No ABI or code changes.
Closes #13.