Re: How to fix docs for Zlib::GzipReader#wrap ?

  This message is in MIME format.  The first part should be readable text,
  while the remaining parts are likely unreadable without MIME-aware tools.

---476953799-520892452-1264003669=:2290
Content-Type: TEXT/PLAIN; CHARSET=ISO-8859-15
Content-ID: <[email protected]>
Content-Transfer-Encoding: quoted-printable

On Wed, 20 Jan 2010, Roger Pack wrote:

> > Is it actually possible to document this in the source so Rdoc will
> > pick this up correctly? =A0Is there anything concise someone can poin=
t
> > me at that will enable me to write the comments in the right place
> > and style for something more useful to show up, even if perfection
> > is not attained? =A0I don't mind trying to make something acceptable,=
 but
> > I'm trying to fix some code using wrap, so don't want to spend too
> > long on the details of creating the docs, if that can be avoided.
>=20
> Yeah I'd probably submit a patch to core with an updated rdoc somehow

I've submitted doc patches before, so that part of the process, including
discussing it as per this URL, is OK.  My difficulty is that I'm failing
to see how to get Rdoc to pick up the docs associated with rb_gzfile_s_wr=
ap
and associate them correctly with GzipReader and GzipWriter.  Maybe I
don't need to do much that's special for that to work, and just make sure
I don't refer to a specific class in the docs there? =20

> [update the .rd file, or move the comments inline, etc.]

It would be moving the comments inline, but it's doing it in=20
such a way that it gets picked up correctly.  For Ruby source
this is much more straightforward, than for C source.

> http://wiki.github.com/rdp/ruby_talk_faq/#should_do_x
>=20
> gl!
> -r
        Thank you,
        Hugh
---476953799-520892452-1264003669=:2290--