summaryrefslogtreecommitdiff
path: root/libguile/strings.c
diff options
context:
space:
mode:
authorNeil Jerram <neil@ossau.uklinux.net>2001-04-09 21:44:06 +0000
committerNeil Jerram <neil@ossau.uklinux.net>2001-04-09 21:44:06 +0000
commit89d04205b416699a9abdb8c2bebff5ca0fbff8f3 (patch)
treeb8d27f657027eb3d01a5daf08e41ac834a75ee2f /libguile/strings.c
parent5411d8825034ded7e03be8dd979fbb3ca3dbe3cb (diff)
downloadguile-89d04205b416699a9abdb8c2bebff5ca0fbff8f3.tar.gz
* Clean up doc and docstring for shared substrings and read only strings.
Diffstat (limited to 'libguile/strings.c')
-rw-r--r--libguile/strings.c11
1 files changed, 2 insertions, 9 deletions
diff --git a/libguile/strings.c b/libguile/strings.c
index 70d831907..476493eef 100644
--- a/libguile/strings.c
+++ b/libguile/strings.c
@@ -74,15 +74,8 @@ SCM_DEFINE (scm_string_p, "string?", 1, 0, 0,
SCM_DEFINE (scm_read_only_string_p, "read-only-string?", 1, 0, 0,
(SCM obj),
- "Return true if @var{obj} can be read as a string,\n\n"
- "This illustrates the difference between @code{string?} and\n"
- "@code{read-only-string?}:\n\n"
- "@lisp\n"
- "(string? \"a string\") @result{} #t\n"
- "(string? 'a-symbol) @result{} #f\n\n"
- "(read-only-string? \"a string\") @result{} #t\n"
- "(read-only-string? 'a-symbol) @result{} #t\n"
- "@end lisp")
+ "Return @code{#t} if @var{obj} is either a string or a symbol,\n"
+ "otherwise return @code{#f}.")
#define FUNC_NAME s_scm_read_only_string_p
{
return SCM_BOOL(SCM_ROSTRINGP (obj));