Bug #9027: [Doc] improve rdoc of Digest module

• Status: Closed
• Assignee: zzak (zzak _)
• Target version: 2.1.0
• ruby -v: ruby 2.0.0p247 (2013-06-27 revision 41674) [i686-linux]
• Backport: 1.9.3: UNKNOWN, 2.0.0: UNKNOWN

[stomar (Marcus Stollsteimer)]

Some improvements in mainly the module documentation:

• provide more examples
• provide a working example for the "bubble babble" encoding
• fix dead link
• fix some typos

(Right now the "bubble babble" thing is completely unclear or rather
essentially undocumented; also the linked to Wikipedia article has been
deleted. I also added examples for MD5--which is otherwise undocumented--,
for different encodings, and for creating a digest for a file.)

[stomar (Marcus Stollsteimer)]

@zzak (zzak _). Any Feedback...?

[zzak (zzak _)]

@stomar (Marcus Stollsteimer) Thanks for the patch! seems good, I will do a full review and try to commit it soon!

[stomar (Marcus Stollsteimer)]

How do you handle backports? Will I have to open separate tickets as soon as this is merged to trunk?

[zzak (zzak _)]

I will handle the backports after reviewing and committing this patch, it's larger so I need a little more time to review.

Thank you!

[zzak (zzak _)]

• Status changed from Open to Assigned

[zzak (zzak _)]

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

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

---

• ext/digest/*: [DOC] Fix several typos and broken http links.
  Improved examples for Digest overview and fixed a broken example in
  Digest::HMAC overview. This patch also adds a description of
  Digest::SHA256.bubblebabble to the Digest overview.

  Patched by @stomar (Marcus Stollsteimer) [Bug #9027]