-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[tech] make some items public #838
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a bunch of new exposed API which are not hidden behind the feature-flag gtfs_parser
:
gtfs::EquipmentList
(which was ingtfs::read::EquipmentList
before andgtfs::read
is private)calendars::manage_calendars
(which waspub(crate)
but is nowpub
and modulecalendars
ispub
)read_utils::FileHandler
(and friendsread_utils::PathFileHandler
andread_utils::ZipFileHandler
) which I really would not expose, at least not without a feature (anotherfile_handler
feature?)read_utils::read_objects
,read_utils::read_collection
andread_opt_collection
, not a fan of exposing those either, but it doesn't make sense to hide it behindgtfs_parser
orfile_handler
features
Idea - maybe it's not a gtfs_parser
feature that we need but 2 features: gtfs
and parser
. You would hide all of gtfs::read
behind #[cfg(all(feature = "gtfs", feature = "parser"))]
and hide the read_*
functions of read_utils
behind #[cfg(feature = "parser")]
?
I was thinking it would be nice to add some documentation about the 2 new introduced features into the preamble of |
I told myself the same thing |
src/lib.rs
Outdated
@@ -38,6 +38,13 @@ | |||
//! mutate a `Model`. It might not be completely stable at the moment so use | |||
//! with care (or not at all!). | |||
//! | |||
//! ## `gtfs` | |||
//! This feature is only used to expose some gtfs functions for use in external projects |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would mention that the exposed API are not stable and that using this is experimental. I'm not expecting us to be as careful about the stability here that for the rest of the exposed API. What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done in 6f11bef
41f1c18
to
d18eb0d
Compare
No description provided.