Fix README example, enforce via doctest - #37
Merged
Conversation
zowens
reviewed
Feb 17, 2022
| pub use crate::{index::Index, index::IndexBuf, segment::Segment}; | ||
| use file_set::FileSet; | ||
| use message::{MessageBuf, MessageError, MessageSet, MessageSetMut}; | ||
| pub use message::{MessageBuf, MessageError, MessageSet, MessageSetMut}; |
Owner
There was a problem hiding this comment.
Was this made pub to fix the example? Since message module is already public, I wonder if it makes sense to update the imports there instead.
jthacker
commented
Feb 17, 2022
via email
ContributorAuthor
Exactly. I wasn’t sure what the expectations were for the API, so I assumed
the desire was to make these available by default based on the example.
Which parts do you want to make public by default? …On Thu, Feb 17, 2022 at 15:31 Zack Owens ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In src/lib.rs
<#37 (comment)>:
> @@ -60,7 +60,7 @@ use std::{
#[cfg(feature = "internals")]
pub use crate::{index::Index, index::IndexBuf, segment::Segment};
use file_set::FileSet;
-use message::{MessageBuf, MessageError, MessageSet, MessageSetMut};
+pub use message::{MessageBuf, MessageError, MessageSet, MessageSetMut};
Was this made pub to fix the example? Since message module is already
public, I wonder if it makes sense to update the imports there instead.
—
Reply to this email directly, view it on GitHub
<#37 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AADONFDWORAKJ7CP3POAZOLU3WAOLANCNFSM5OTHKMQQ>
.
Triage notifications on the go with GitHub Mobile for iOS
<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675>
or Android
<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
zowens
commented
Feb 25, 2022
Owner
@jthacker |
jthacker
commented
Mar 4, 2022
ContributorAuthor
@zowens I've updated the examples to require using the additional import instead of exporting it in lib. Hope that aligns with the expectations. |
jthacker
commented
Apr 12, 2022
ContributorAuthor
@zowens Following up on this PR. Any other changes you'd like to see? |
zowens
approved these changes
Apr 12, 2022
zowens
commented
Apr 12, 2022
Owner
Thanks @jthacker! |
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 freeto 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.
No description provided.