[#3228] Core support for Gems, and namespace — "Luke A. Kanies" <luke@...>

Hi all,

21 messages 2004/07/27
[#3230] Re: Core support for Gems, and namespace — Austin Ziegler <halostatue@...> 2004/07/27

On Tue, 27 Jul 2004 11:39:08 +0900, Luke A. Kanies <luke@madstop.com> wrote:

[#3234] Re: Core support for Gems, and namespace — "Luke A. Kanies" <luke@...> 2004/07/27

On Tue, 27 Jul 2004, Austin Ziegler wrote:

[#3238] Re: Core support for Gems, and namespace — Austin Ziegler <halostatue@...> 2004/07/27

On Wed, 28 Jul 2004 00:14:29 +0900, Luke A. Kanies <luke@madstop.com> wrote:

Re: [doc] Inconsistent "call-seq" usage etc.

From: Dave Thomas <dave@...>
Date: 2004-07-12 19:28:08 UTC
List: ruby-core #3176
On Jul 12, 2004, at 14:03, Johan Holmberg wrote:

> I don't know enough about the RDoc markup, but as far as I
> understand, the documentation of a Ruby-method can't have a
> "call-seq" entry (overriding the automatically generated info).
>

Call-seq for Ruby methods was added this morning :)

> What would be in the "spirit" of RDoc ?

In general I'd avoid call-seq unless the documentation was unclear 
without it. RDoc documentation is supposed to contain almost no 
explicit markup, and I'm resisting the temptation to add more. In this 
particular case, several folks made a good case for call-seq, but in 
general I'd rather see it used sparingly.

Cheers

Dave


In This Thread