From 3e637151987c24ef39f36660a2b4b60d50c292d2 Mon Sep 17 00:00:00 2001 From: Patrick McCarty Date: Sat, 25 Jul 2009 01:21:51 -0700 Subject: [PATCH] Docs: IR: standardize type-predicate docstring format --- lily/general-scheme.cc | 7 ++++--- lily/music-scheme.cc | 5 ++--- lily/paper-system-scheme.cc | 2 +- lily/simple-closure.cc | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/lily/general-scheme.cc b/lily/general-scheme.cc index 09185f5888..0cf2299b2e 100644 --- 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 1f9b2c0e29..1bef06a8ed 100644 --- 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 137cef0c5c..b0f74eac0e 100644 --- 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 34bfd58f1b..dc4c3f4f7f 100644 --- 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)); } -- 2.39.5