Doc Challenge Update

drbrain | Sat, 14 May 2011 21:59:00 GMT

Posted in ,

Here's an update on the Ruby 1.9.3 Documentation Challenge. Since Monday, Ruby's documentation coverage has grown to 59.02%. Thanks to the following contributors for improving Ruby's documentation coverage:

Vincent Batts
#4695
#4690
#4677
#4664
Simon Chiang
#4694
Justin Collins
#4693
Sebastian Martinez
#4688
#4687
Mark Turner
#4691
#4671
Darragh Curran
#4684
Jason Dew
#4667
Sergio Gil Pérez de la Manga
#4678
Pete Higgins
#4665
RDoc issue #34
Steve Klabnik
#4663

It seems my goal of 60% was pessimistic as coverage has grown 5% in only a week. There's still plenty of time to help and you can find all the resources you need to get started on the Documentation Challenge post.

Here's the report from ruby trunk r31570:

Files:        728

Classes:     1299 ( 700 undocumented)
Modules:      296 ( 163 undocumented)
Constants:   1295 ( 914 undocumented)
Attributes:  1025 ( 479 undocumented)
Methods:    10108 (3491 undocumented)

Total:      14023 (5747 undocumented)
 59.02% documented

Here's Monday's report:

Files:        511

Classes:     1036 ( 624 undocumented)
Modules:      228 ( 136 undocumented)
Constants:   1335 (1134 undocumented)
Attributes:   738 ( 381 undocumented)
Methods:     8098 (2960 undocumented)

Total:      11435 (5235 undocumented)
 54.22% documented

I also removed lib/.document which artificially restricted the files RDoc was allowed to parse which added 331 classes and modules. comment

Comments RSS FEED

Comments are disabled