Skip to content

Commit

Permalink
Fix missing spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
robin850 committed Aug 5, 2012
1 parent f29832c commit 229e6c0
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions site/features.md
Expand Up @@ -9,7 +9,7 @@ for meta tags alongside regular code
documentation. These tags should be able to happily sit side by side RDoc formatted
documentation, but provide a much more consistent and usable way to describe
important information about objects, such as what parameters they take and what types
they are expected to be, what type amethod should return, what exceptions it can
they are expected to be, what type a method should return, what exceptions it can
raise, if it is deprecated, etc.. It also allows information to be better (and more
consistently) organizedduring the output generation phase. You can find a list
of tags in the [Tags.md](http://yardoc.org/docs/yard/file/docs/Tags.md#List_of_Available_Tags) file.
Expand Down Expand Up @@ -41,7 +41,7 @@ descriptive.
## RDoc Formatting Compatibility

YARD is made to be compatiblewith RDoc formatting. In fact, YARD does no
processing on RDoc documentationstrings, and leaves this up to the output
processing on RDoc documentation strings, and leaves this up to the output
generation tool to decide how to render the documentation.

## A Local Documentation Server
Expand Down Expand Up @@ -85,14 +85,14 @@ any markup.

## Raw Data Output

YARD also outputs documented objects as raw data (thedumped Namespace) which
can be reloaded to do generation at a later date, oreven auditing on code. This
YARD also outputs documented objects as raw data (the dumped Namespace) which
can be reloaded to do generation at a later date, or even auditing on code. This
means that any developer can use the raw data toperform output generation for
any custom format, such as YAML, for instance.While YARD plans to support XHTML
style documentation output as well ascommand line (text based) and possibly XML,
style documentation output as well as command line (text based) and possibly XML,
this may still be useful for those who would like to reap the benefits of YARD's
processing in other forms, suchas throwing all the documentation into a database.
Another useful way ofexploiting this raw data format would be to write tools
processing in other forms, such as throwing all the documentation into a database.
Another useful way of exploiting this raw data format would be to write tools
that can auto generate test cases, for example, or show possible unhandled
exceptions in code.

0 comments on commit 229e6c0

Please sign in to comment.