Re: [frogs] Assignment #1

["Carl D. Sorensen" <c_sorensen@xxxxxxx>]

When you do it, don't forget to use @var{} instead of @code{} in your
docstrings, and fix any existing uses of @code{}.

According to the CG, @code{} should only be used for LilyPond commands, so
@code{\addlyrics} is correct, but @code{var1} is incorrect, and should be
@var{var1}.

Thanks,

Carl


On 1/11/09 9:56 PM, "Andrew Hawryluk" <ahawryluk@xxxxxxxxx> wrote:

> Yes. I shall do that. Glad to hear that I got the patch right!
> 
> On Sat, Jan 10, 2009 at 8:06 AM, Carl D. Sorensen <c_sorensen@xxxxxxx> wrote:
>> 
>> 
>> 
>> On 1/9/09 12:34 PM, "Andrew Hawryluk" <ahawryluk@xxxxxxxxx> wrote:
>> 
>>> Hi Carl et al.,
>>> 
>>> Here's my eight doc strings, including one that will require the new
>>> def-grace-function.
>> 
>> Andrew,
>> 
>> Thanks for this work.  The patch is formatted properly, and the docstrings
>> have been set for internationalization (including adding it to the one for
>> addChordShape).
>> 
>> An ideal docstring will include the parameters to the function in the call.
>> 
>> So, for example,
>>  addQuote =
>>  #(define-music-function (parser location name music) (string? ly:music?)
>> -   (_i "Add a piece of music to be quoted ")
>> +   (_i "Add a piece of music to be quoted")
>> 
>> Should probably be modified to something like
>> 
>>  addQuote =
>>  #(define-music-function (parser location name music) (string? ly:music?)
>> -   (_i "Add a piece of music to be quoted ")
>> +   (_i "Add @code{music} as a quotable fragment named @code{name}.")
>> 
>> Can you check all of your docstrings to see that they include the arguments?
>> 
>> Thanks,
>> 
>> Carl
>> 
>> 
>> ---
>> 
>> ----
>> Join the Frogs!
>> 
> 
> ---
> 
> ----
> Join the Frogs!


---

----
Join the Frogs!