*/
LY_DEFINE (ly_gulp_file, "ly:gulp-file",
1, 1, 0, (SCM name, SCM size),
- "Read the file @var{name}, and return its contents in a string."
+ "Read @var{size} characters from the file @var{name},"
+ " and return its contents in a string."
+ " If @var{size} is undefined, the entire file is read."
" The file is looked up using the search path.")
{
LY_ASSERT_TYPE (scm_is_string, name, 1);
LY_DEFINE (ly_success, "ly:success",
1, 0, 1, (SCM str, SCM rest),
- "A Scheme callable function to issue a success message @code{str}."
- " The message is formatted with @code{format} and @code{rest}.")
+ "A Scheme callable function to issue a success message @var{str}."
+ " The message is formatted with @code{format} and @var{rest}.")
{
LY_ASSERT_TYPE (scm_is_string, str, 1);
str = scm_simple_format (SCM_BOOL_F, str, rest);
}
LY_DEFINE (ly_warning, "ly:warning",
1, 0, 1, (SCM str, SCM rest),
- "A Scheme callable function to issue the warning @code{str}."
- " The message is formatted with @code{format} and @code{rest}.")
+ "A Scheme callable function to issue the warning @var{str}."
+ " The message is formatted with @code{format} and @var{rest}.")
{
LY_ASSERT_TYPE (scm_is_string, str, 1);
str = scm_simple_format (SCM_BOOL_F, str, rest);
LY_DEFINE (ly_number_2_string, "ly:number->string",
1, 0, 0, (SCM s),
- "Convert @var{num} to a string without generating many decimals.")
+ "Convert @var{s} to a string without generating many decimals.")
{
LY_ASSERT_TYPE (scm_is_number, s, 1);
return (ly_symbol2string (arg));
else
{
- ly_progress (scm_from_locale_string ("Unsupported SCM value for format: ~a"),
+ ly_progress (scm_from_locale_string ("\nUnsupported SCM value for format: ~a"),
scm_list_1 (arg));
}
LY_DEFINE (ly_format, "ly:format",
1, 0, 1, (SCM str, SCM rest),
- "LilyPond specific format, supporting @code{~a} and @code{~[0-9]f}. "
- "Basic support for @code{~s} is also provided.")
+ "LilyPond specific format, supporting @code{~a} and @code{~[0-9]f}."
+ " Basic support for @code{~s} is also provided.")
{
LY_ASSERT_TYPE (scm_is_string, str, 1);
if (scm_is_pair (rest))
programming_error (string (__FUNCTION__)
- + ": too many arguments");
+ + ": too many arguments");
vsize len = 0;
for (vsize i = 0; i < results.size (); i++)