update undocumented and poor documented list, and add recently generated coverage report files

Author: Zachary Scott

_posts/2011-10-06-step-by-step-guide.markdown

@@ -43,6 +43,10 @@ Search for "is not documented" in "documentation_coverage.txt". Find something
 that interests you, and document it. You can see how much of Ruby is documented
 by looking at the stats at the bottom of the file.
 
+We have generated a few of these reports for various areas of the MRI source,
+see our <a href="/undocumented-areas.html#CoverageReport">undocumented coverage
+report</a>.
+
 <a name="Documenting"></a>
 <a class="top" href="#">top</a>
 ## Documenting

_posts/2011-10-07-undocumented-areas.markdown

@@ -15,25 +15,17 @@ Many modules in Ruby lack a basic top-level description of what they do. In many
 ### Classes/Modules which lack documentation
 
   -  Debug
-  -  Encoding
   -  Fiddle
-  -  IRB*
-  -  Mkmf
-  -  Monitor::MonitorMixin
-  -  Mutex_m
   -  Profile, Profiler
-  -  RbConfig
   -  RSS
-  -  Thread
+  -  RbConfig
 
 ### Classes/Modules with poor documentation
 
   - ARGF
   - CMath need clarifications (Complex is now in core, what does it do now?)
   - Digest: no examples (Digest::MD5 is not even in the class list)
-  - Enumerable
-  - Float
-  - PTY
+  - OptionParser
   - Racc
   - Rinda
   - Sync, Sync_m
@@ -42,12 +34,18 @@ Many modules in Ruby lack a basic top-level description of what they do. In many
 ### More specialized things
 
   - initialize_copy
-  - Object#hash
 
+<a name="CoverageReport"></a>
+<a class="top" href="#">top</a>
+### Undocumented Coverage Report
 
-### Some other tips for finding areas to document
+We also have a report of undocumented modules, classes, and methods that was
+generated from RDoc using the `rdoc -C path/to/files` command.
 
-  - Look near `Init_<class name>` in `<class_name>.c`
+* <a href="/assets/undocumented_core.txt">Core classes</a>
+* <a href="/assets/undocumented_lib.txt">Standard Ruby libraries</a>
+* <a href="/assets/undocumented_ext.txt">Standard Ruby extensions</a>
 
-  - [List of class-level documentation by byte length](https://gist.github.com/1254953). Low numbers don't necessarily mean poor documentation, but if you see a much-used class low on the list, it may be a candidate for improvement. 
+### Some other tips for finding areas to document
 
+  - Look near `Init_<class name>` in `<class_name>.c`

assets/undocumented_core.txt

@@ -0,0 +1,105 @@
+
+The following items are not documented:
+
+class File # is documented
+
+  # in file file.c
+  Separator = nil
+  # in file file.c
+  SEPARATOR = nil
+  # in file file.c
+  ALT_SEPARATOR = nil
+  # in file file.c
+  PATH_SEPARATOR = nil
+end
+
+class Hash # is documented
+
+  # in file hash.c:1216
+  def initialize_copy(p1); end
+
+end
+
+class IO # is documented
+
+  # in file io.c
+  SEEK_SET = nil
+  # in file io.c
+  SEEK_CUR = nil
+  # in file io.c
+  SEEK_END = nil
+end
+
+module Kernel # is documented
+
+  # in file eval.c:1495
+  def __callee__(); end
+
+end
+
+
+class LoadError # is documented
+
+  attr_reader :path # in file error.c
+end
+
+
+module Marshal # is documented
+
+  # in file marshal.c
+  MAJOR_VERSION = nil
+  # in file marshal.c
+  MINOR_VERSION = nil
+end
+
+
+module Math # is documented
+
+  # in file math.c
+  PI = nil
+  # in file math.c
+  E = nil
+end
+
+
+module Process::GID # is documented
+
+  # in file process.c:4819
+  def self.from_name(p1); end
+
+end
+
+module Process::UID # is documented
+
+  # in file process.c:4771
+  def self.from_name(p1); end
+
+end
+
+class Random # is documented
+
+  # in file random.c
+  DEFAULT = nil
+end
+
+class RubyVM # is documented
+
+  # in file vm.c
+  USAGE_ANALYSIS_REGS = nil
+  # in file vm.c
+  USAGE_ANALYSIS_INSN_BIGRAM = nil
+end
+
+
+Files:        77
+
+Classes:      91 ( 0 undocumented)
+Modules:      18 ( 0 undocumented)
+Constants:   115 (14 undocumented)
+Attributes:    1 ( 1 undocumented)
+Methods:    1677 ( 4 undocumented)
+
+Total:      1902 (19 undocumented)
+ 99.00% documented
+
+Elapsed: 34.4s