Project

General

Profile

Bug #4702

Some documentation for Digest

Added by phiggins (Pete Higgins) about 6 years ago. Updated about 6 years ago.

Status:
Closed
Priority:
Normal
Target version:
-
ruby -v:
ruby 1.9.3dev (2011-05-13 trunk 31542) [x86_64-linux]
[ruby-core:36212]

Description

Some of the methods in the Digest family were undocumented or badly formatted. This patch adds a little polish.

These docs could probably stand to be restructured, but this takes care of the obvious bad spots.

digest_docs.diff View (6.34 KB) phiggins (Pete Higgins), 05/16/2011 11:34 AM

Associated revisions

Revision 31594
Added by drbrain (Eric Hodel) about 6 years ago

  • ext/digest: Improve documentation of Digest, Digest::HMAC and Digest::SHA2. Patch by Pete Higgins. [Ruby 1.9 - Bug #4702]

Revision 31594
Added by drbrain (Eric Hodel) about 6 years ago

  • ext/digest: Improve documentation of Digest, Digest::HMAC and Digest::SHA2. Patch by Pete Higgins. [Ruby 1.9 - Bug #4702]

Revision 31594
Added by drbrain (Eric Hodel) about 6 years ago

  • ext/digest: Improve documentation of Digest, Digest::HMAC and Digest::SHA2. Patch by Pete Higgins. [Ruby 1.9 - Bug #4702]

Revision 31594
Added by drbrain (Eric Hodel) about 6 years ago

  • ext/digest: Improve documentation of Digest, Digest::HMAC and Digest::SHA2. Patch by Pete Higgins. [Ruby 1.9 - Bug #4702]

History

#1 Updated by drbrain (Eric Hodel) about 6 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r31594.
Pete, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • ext/digest: Improve documentation of Digest, Digest::HMAC and Digest::SHA2. Patch by Pete Higgins. [Ruby 1.9 - Bug #4702]

#2 [ruby-core:36237] Updated by drbrain (Eric Hodel) about 6 years ago

I made a few changes:

Reduced indentation for verbatim sections from four spaces to two

Changed digest_obj to hmac in Digest::HMAC documentation

Also available in: Atom PDF