8000 Update readme for similar format to other Mailtrap SDKs by DagonWat · Pull Request #79 · mailtrap/mailtrap-ruby · GitHub
[go: up one dir, main page]

Skip to content

Conversation

@DagonWat
Copy link
@DagonWat DagonWat commented Dec 18, 2025

Motivation

  • We need to keep SDKs Readme's in same format and standard

Changes

  • Update README.md

@DagonWat DagonWat changed the base branch from main to add-projects-api December 18, 2025 10:49
@DagonWat DagonWat requested review from IgorDobryn and i7an December 18, 2025 10:49
Email API:
- Full email sending – [`full.rb`](examples/full.rb)

### Content-Transfer-Encoding
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So you simply removed a chunk of documentation. Maybe it should be moved somewhere instead?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, my idea was that if other libs are not utilizing these points, it means these points were suppressed on its way to our SDK documentation formats. These 2 paragraphs 'Content-Transfer-Encoding' and 'Multiple Mailtrap Clients' are not existing in other major libraries while they absolutely make same sense to be there.

Do you vote for me to keep them?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah lets keep them. Those chapters were added to address customer requests. I dont see the value in removing the documentation. If your goal is to unify the structure, please do that and keep the existing docs.

@i7an
Copy link
Contributor
i7an commented Dec 22, 2025

The PR description is probably not up to date.

@mailtrap mailtrap deleted a comment from coderabbitai bot Dec 23, 2025
@coderabbitai
Copy link
coderabbitai bot commented Dec 26, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-readme-for-similar-format

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@DagonWat DagonWat requested a review from i7an December 26, 2025 17:30
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.

4 participants

0