Skip to content

Updated docs, especially TLS and SASL-related - #66

Merged
tmtm merged 1 commit into
ruby:masterfrom
nevans:minor-documentation-fixes
Nov 4, 2023
Merged

Updated docs, especially TLS and SASL-related#66
tmtm merged 1 commit into
ruby:masterfrom
nevans:minor-documentation-fixes

Conversation

@nevans

@nevansnevans commented Oct 9, 2023

Copy link
Copy Markdown
Contributor
  • 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
nevansforce-pushed the minor-documentation-fixes branch from 058ad83 to 8fa0f46CompareOctober 11, 2023 14:11
@nevansnevans changed the title Make several minor documentation fixesUpdated docs, especially TLS and SASL-relatedOct 11, 2023
@nevans

Copy link
Copy Markdown
ContributorAuthor

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!

@nevans
nevansforce-pushed the minor-documentation-fixes branch 2 times, most recently from 7800ec6 to 6b0548aCompareOctober 14, 2023 16:30
@nevans
nevansforce-pushed the minor-documentation-fixes branch from 6b0548a to 2cfc961CompareOctober 15, 2023 10:29
Comment threadlib/net/smtp.rb Outdated
Comment threadlib/net/smtp.rb Outdated
* 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
nevansforce-pushed the minor-documentation-fixes branch from 2cfc961 to d9fe72aCompareOctober 21, 2023 00:02
@nevansnevans 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
@nevansnevans reopened this Oct 21, 2023
@tmtm
tmtm merged commit b50e9a4 into ruby:masterNov 4, 2023
@nevans
nevans deleted the minor-documentation-fixes branch November 7, 2023 03:55
Sign up for freeto 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.

2 participants

@nevans@tmtm