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

Updated docs, especially TLS and SASL-related #66

Merged
merged 1 commit into from
Nov 4, 2023

Conversation

nevans
Copy link
Contributor

@nevans nevans commented Oct 9, 2023

  • Escaped SMTP in many places where it refers to the protocol, not the
    class.
  • Fixed some ruby example syntax, so rdoc syntax highlighting works.
  • Separated SMTP.start or SMTP#start, so rdoc can link both methods.
  • Updated the RFC links. Fixed link to RFC6409 (not 6503!).
  • Linked to the mail (previously TMail) and rmail (previously
    RubyMail) gems.
  • Fixed <tt> formatting issues.
  • "See also" links from start methods.
  • Removed detailed documentation for deprecated LOGIN and CRAM-MD5.
  • Clarified authentication arg docs to Net::SMTP.start and #start.
    • Linked directly to Net::SMTP@SMTP+Authentication.

This handles several of the areas I've been working on (or adjacent to) in my other PRs. Everything in this PR should be accurate for the current release.

@nevans nevans changed the title Make several minor documentation fixes Updated docs, especially TLS and SASL-related Oct 11, 2023
@nevans
Copy link
Contributor Author

nevans commented Oct 11, 2023

FYI: as I went through several of my other branches, I realized that some of their documentation changes were applicable to the master branch... so I pulled those changes back in here. And then I went and made several more changes. So I renamed the PR: it's not just a few minor changes any more!

lib/net/smtp.rb Outdated Show resolved Hide resolved
lib/net/smtp.rb Outdated Show resolved Hide resolved
* Escaped SMTP in many places where it refers to the protocol, not the
  class.
* Fixed some ruby example syntax, so rdoc syntax highlighting works.
* Separated `SMTP.start or SMTP#start`, so rdoc can link both methods.
* Updated the RFC links.  Fixed link to RFC6409 (not 6503!).
* Linked to the `mail` (previously TMail) and `rmail` (previously
  RubyMail) gems.
* Fixed `<tt>` formatting issues.
* "See also" links from `start` methods.
* Removed detailed documentation for deprecated `LOGIN` and `CRAM-MD5`.
* Clarified authentication arg docs to Net::SMTP.start and #start.
  * Linked directly to Net::SMTP@SMTP+Authentication.
@nevans nevans closed this Oct 21, 2023
@nevans nevans deleted the minor-documentation-fixes branch October 21, 2023 00:30
@nevans nevans restored the minor-documentation-fixes branch October 21, 2023 00:31
@nevans nevans reopened this Oct 21, 2023
@tmtm tmtm merged commit b50e9a4 into ruby:master Nov 4, 2023
24 checks passed
@nevans nevans deleted the minor-documentation-fixes branch November 7, 2023 03:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants