lilypond-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Update docstring for ly:gulp-file (issue2754041)


From: Carl . D . Sorensen
Subject: Update docstring for ly:gulp-file (issue2754041)
Date: Tue, 26 Oct 2010 20:44:24 +0000

Reviewers: ,

Message:
Here's a proposed docstring for ly:gulp-file.

Any comments or questions?

Thanks,

Carl


Description:
Update docstring for ly:gulp-file

Please review this at http://codereview.appspot.com/2754041/

Affected files:
  M lily/general-scheme.cc


Index: lily/general-scheme.cc
diff --git a/lily/general-scheme.cc b/lily/general-scheme.cc
index 8359e8fc5bb3a2fce775369dc9a0e6955138cfa2..dafa8f750f4127257497d4005c11f9d79bfac5ed 100644
--- a/lily/general-scheme.cc
+++ b/lily/general-scheme.cc
@@ -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 @code{SCM_UNDEFINED}, the entire file is read."
           "  The file is looked up using the search path.")
 {
   LY_ASSERT_TYPE (scm_is_string, name, 1);





reply via email to

[Prev in Thread] Current Thread [Next in Thread]