Docs: IR: standardize type-predicate docstring format

diff --git a/lily/general-scheme.cc b/lily/general-scheme.cc
index 09185f5888b2e8597d2373783b4ff1acb0c281b6..0cf2299b2ec6c9e0579d99846060ad69c196587b 100644 (file)
--- a/lily/general-scheme.cc
+++ b/lily/general-scheme.cc
@@ -140,9 +140,10 @@ LY_DEFINE (ly_warning, "ly:warning",
 
 LY_DEFINE (ly_dir_p, "ly:dir?",
           1, 0, 0, (SCM s),
-          "A type predicate.  The direction@tie{}@code{s} is @code{-1},"
-          " @code{0} or@tie{}@code{1}, where @code{-1} represents"
-          " left or down and @code{1} represents right or up.")
+          "Is @var{s} a direction?  Valid directions are @code{-1},"
+          " @code{0}, or@tie{}@code{1}, where @code{-1} represents"
+          " left or down, @code{1} represents right or up, and @code{0}"
+          " represents a neutral direction.")
 {
   if (scm_is_number (s))
     {

diff --git a/lily/music-scheme.cc b/lily/music-scheme.cc
index 1f9b2c0e29de4b670ba9d3dc533707e34b75c34d..1bef06a8ed82a60615676d6dd82ac7457f16300c 100644 (file)
--- a/lily/music-scheme.cc
+++ b/lily/music-scheme.cc
@@ -58,7 +58,7 @@ LY_DEFINE (ly_make_music, "ly:make-music",
 
 LY_DEFINE (ly_music_p, "ly:music?",
           1, 0, 0, (SCM obj),
-          "Type predicate.")
+          "Is @var{obj} a Music object?")
 {
   return scm_from_bool (unsmob_music (obj));
 }
@@ -77,8 +77,7 @@ LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
 
 LY_DEFINE (ly_music_list_p, "ly:music-list?",
           1, 0, 0, (SCM lst),
-          "Type predicate: Return true if @var{lst} is a list"
-          " of music objects.")
+          "Is @var{lst} a list of music objects?")
 {
   if (scm_list_p (lst) == SCM_BOOL_T)
     while (scm_is_pair (lst))

diff --git a/lily/paper-system-scheme.cc b/lily/paper-system-scheme.cc
index 137cef0c5c2f22f6d0c22febf16324babaf34206..b0f74eac0effbc7b77146b61788b427507bd6461 100644 (file)
--- a/lily/paper-system-scheme.cc
+++ b/lily/paper-system-scheme.cc
@@ -13,7 +13,7 @@
   
 LY_DEFINE (ly_paper_system_p, "ly:paper-system?",
          1, 0, 0, (SCM obj),
-         "Type predicate.")
+         "Is @var{obj} a Prob object of type @code{paper-system}?")
 {
   return ly_prob_type_p (obj, ly_symbol2scm ("paper-system"));
 }

diff --git a/lily/simple-closure.cc b/lily/simple-closure.cc
index 34bfd58f1bb6d06741b031a3d1cee0785d451e77..dc4c3f4f7fdffdcc28bcae04413b07e3f6b40b02 100644 (file)
--- a/lily/simple-closure.cc
+++ b/lily/simple-closure.cc
@@ -84,8 +84,8 @@ evaluate_with_simple_closure (SCM delayed_argument,
 }
 
 LY_DEFINE (ly_simple_closure_p, "ly:simple-closure?",
-         1,0,0, (SCM clos),
-         "Type predicate.")
+         1, 0, 0, (SCM clos),
+         "Is @var{clos} a simple closure?")
 {
   return scm_from_bool (is_simple_closure (clos));
 }