]> git.donarmstrong.com Git - lilypond.git/commitdiff
Update docstring for ly:gulp-file
authorCarl Sorensen <c_sorensen@byu.edu>
Tue, 26 Oct 2010 20:23:19 +0000 (14:23 -0600)
committerCarl Sorensen <c_sorensen@byu.edu>
Thu, 28 Oct 2010 03:16:17 +0000 (21:16 -0600)
lily/general-scheme.cc

index 8359e8fc5bb3a2fce775369dc9a0e6955138cfa2..eb1947509df6b2a1a67b27bb6e7ab5db85f408c1 100644 (file)
@@ -79,7 +79,9 @@ LY_DEFINE (ly_find_file, "ly:find-file",
 */
 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);