Skip to content
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

docs: Improve code examples #397

Merged
merged 3 commits into from
Dec 7, 2023
Merged

Conversation

coalooball
Copy link
Contributor

See #393

@coalooball
Copy link
Contributor Author

Also see #394

@duesee
Copy link
Owner

duesee commented Dec 7, 2023

Hehe, I was just about to merge because I overlooked https://github.com/duesee/imap-codec/pull/397/files#diff-cfcb5beb66760b7d974ea036d027714665a3c57f72ca940df6dcdd3e138a1d69R24-R32 :D Good that we have a CI :-) I think it should be enough to remove this? Same with https://github.com/duesee/imap-codec/pull/397/files#diff-cfcb5beb66760b7d974ea036d027714665a3c57f72ca940df6dcdd3e138a1d69R65-R72? Maybe also toss a cargo +nightly fmt just in case.

@coalooball
Copy link
Contributor Author

Whoops (○´・д・)ノ my bad, I didn't use cargo t to test. Thought the code below was a no-go:

//! # use imap_codec::{
//! # encode::Encoder,
//! # imap_types::{
//! # core::Text,
//! # response::{Code, Greeting, GreetingKind},
//! # },
//! # GreetingCodec,
//! # };

I originally wanted to write a separate section to specifically explain how to use imap-types, but I thought it would be better to write it as a comment in the code, so I deleted your previous code. Now, cargo t aced the test. The CI is my lifesaver!

@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 7130307555

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 92.448%

Totals Coverage Status
Change from base Build 7129545557: 0.0%
Covered Lines: 8728
Relevant Lines: 9441

💛 - Coveralls

@duesee duesee merged commit 739e5d2 into duesee:main Dec 7, 2023
11 checks passed
@duesee
Copy link
Owner

duesee commented Dec 7, 2023

Thanks! :-)

@duesee
Copy link
Owner

duesee commented Dec 7, 2023

Oh, btw @coalooball: Was this your first PR on GitHub? I feel honored! :D Congratz 🎉

@coalooball
Copy link
Contributor Author

Haha, this is my first PR, and I'm pretty excited about it. Thank you for your blessings, @duesee! I hope I can become as awesome as you, contributing real-code PRs to imap-codec.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants