Content preview: On 16.06.2011 23:55, Justin C. wrote: > Markus
wrote: >> - Is there an encouragement to document private methods?
it would >> be nice if they could be omitted from the coverage.
just so we >> know what the goal is. >> > > I can’t speak for Eric,
think part of documenting is marking the > code which does not need
with :nodoc: […]
Content analysis details: (-2.9 points, 5.0 required)
pts rule name description
-1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP
-1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1%
cv=HQ3F56nxkum+cgCiDL7AXQpbvw7DWrWCBJRnYYnM0Zc= c=1 sm=0
a=CPlwVjms4CEA:10 a=rDlpkb2S-8kA:10 a=IkcTkHD0fZMA:10 a=CH-RE0sgAAAA:8
a=dpcX-2CAAAAA:8 a=y3b3jT8EjhXMX-GLqS4A:9 a=QEXdDO2ut3YA:10
a=wPposIssD2IA:10 a=-w7TLmJE7m8A:10 a=VFu7tLI1AyYA:10
Content-Type: text/plain; charset=UTF-8
List-Software: fml [fml 4.0.3 release (20011202/4.0.3)]
List-Post: mailto:[email protected]
List-Owner: mailto:[email protected]
List-Help: mailto:[email protected]?body=help
List-Unsubscribe: mailto:[email protected]?body=unsubscribe
Received-SPF: none (Address does not pass the Sender Policy Framework)
On 16.06.2011 23:55, Justin C. wrote:
Markus F. wrote:
- Is there an encouragement to document private methods? If not it would
be nice if they could be omitted from the coverage. Otherwise just so we
know what the goal is.
I can’t speak for Eric, but I think part of documenting is marking the
code which does not need documenting with :nodoc:
But rdoc, at least by default, does not document private methods. I
assume it’s just a limitation of the coverage tool for now.
Ever since 1.9 came out, I’ve felt like ruby-doc.org has fallen behind.
rdoc.info has been my go-to site for documentation:
Thanks, I quickly noticed it contains stdlib but not core.
I’m still looking for a convenient way to quickly search through the
current docs. Currently I use a FF4 keyworded search which uses the
integrated search on ruby-doc.org :
The results I get back when I search for e.g. split or other methods are
often nearly perfect. That’s where I also found Addrinfo.
The advantage at ruby-doc, at least for me, is that it includes core;
and I need core too.