[dagster-pipes-rust] 📝 Sort exports and update docs for public-facing traits #64
Conversation
This file contains 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
christeefy
force-pushed
the
streamline-public-interface
branch
from
740ec4a to
2a56f73
Compare
christeefy
changed the title
marijncv
approved these changes
Dec 19, 2024
christeefy
added a commit
that referenced
this pull request
Dec 19, 2024
* 🔥 Use `From` trait where possible * 📝 Only re-export `PipesMetadataValue` for public use * 📝 Sort exports and update docs for public-facing traits (#64)
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 & Motivation
It's not clear what's types are publiclly exposed. Exposing too much may lead to unnecessary breaking changes in the future.
As such, public re-exports (
pub use ...) are grouped separately inlib.rs.I also took this chance to improve the docs for public facing types and traits.
With changes here and from #61, here's the exposed surface area:
How I Tested These Changes
dagster dev.Changelog
Ensure that an entry has been created in
CHANGELOG.mdoutlining additions, deletions, and/or modifications.See: keepachangelog.com