Forum: Ruby-core [ruby-trunk - Bug #9027][Open] [Doc] improve rdoc of Digest module

C4e88907313843cf07f6d85ba8162120?d=identicon&s=25 stomar (Marcus Stollsteimer) (Guest)
on 2013-10-16 13:36
(Received via mailing list)
Issue #9027 has been reported by stomar (Marcus Stollsteimer).

----------------------------------------
Bug #9027: [Doc] improve rdoc of Digest module
https://bugs.ruby-lang.org/issues/9027

Author: stomar (Marcus Stollsteimer)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: doc
Target version: current: 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


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.)
C4e88907313843cf07f6d85ba8162120?d=identicon&s=25 stomar (Marcus Stollsteimer) (Guest)
on 2013-10-28 10:44
(Received via mailing list)
Issue #9027 has been updated by stomar (Marcus Stollsteimer).


@zzak. Any Feedback...?
----------------------------------------
Bug #9027: [Doc] improve rdoc of Digest module
https://bugs.ruby-lang.org/issues/9027#change-42644

Author: stomar (Marcus Stollsteimer)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: doc
Target version: current: 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


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.)
054b5f6b8afdd5f6190bad08e46cd782?d=identicon&s=25 zzak (Zachary Scott) (Guest)
on 2013-10-28 22:33
(Received via mailing list)
Issue #9027 has been updated by zzak (Zachary Scott).


@stomar Thanks for the patch! seems good, I will do a full review and
try to commit it soon!
----------------------------------------
Bug #9027: [Doc] improve rdoc of Digest module
https://bugs.ruby-lang.org/issues/9027#change-42646

Author: stomar (Marcus Stollsteimer)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: doc
Target version: current: 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


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.)
C4e88907313843cf07f6d85ba8162120?d=identicon&s=25 stomar (Marcus Stollsteimer) (Guest)
on 2013-10-29 08:55
(Received via mailing list)
Issue #9027 has been updated by stomar (Marcus Stollsteimer).


How do you handle backports? Will I have to open separate tickets as
soon as this is merged to trunk?
----------------------------------------
Bug #9027: [Doc] improve rdoc of Digest module
https://bugs.ruby-lang.org/issues/9027#change-42647

Author: stomar (Marcus Stollsteimer)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: doc
Target version: current: 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


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.)
054b5f6b8afdd5f6190bad08e46cd782?d=identicon&s=25 zzak (Zachary Scott) (Guest)
on 2013-11-10 00:39
(Received via mailing list)
Issue #9027 has been updated by zzak (Zachary Scott).


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!
----------------------------------------
Bug #9027: [Doc] improve rdoc of Digest module
https://bugs.ruby-lang.org/issues/9027#change-42835

Author: stomar (Marcus Stollsteimer)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: doc
Target version: current: 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


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.)
054b5f6b8afdd5f6190bad08e46cd782?d=identicon&s=25 zzak (Zachary Scott) (Guest)
on 2013-11-10 00:39
(Received via mailing list)
Issue #9027 has been updated by zzak (Zachary Scott).

Status changed from Open to Assigned


----------------------------------------
Bug #9027: [Doc] improve rdoc of Digest module
https://bugs.ruby-lang.org/issues/9027#change-42836

Author: stomar (Marcus Stollsteimer)
Status: Assigned
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: doc
Target version: current: 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


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.)
This topic is locked and can not be replied to.