summaryrefslogtreecommitdiff
path: root/doc/api-keys.texi
diff options
context:
space:
mode:
authorArtyom V. Poptsov <poptsov.artyom@gmail.com>2014-08-30 12:18:21 +0400
committerArtyom V. Poptsov <poptsov.artyom@gmail.com>2014-08-30 21:33:21 +0400
commit121df67f1894fb06f12a1f60ce040b32c73628f6 (patch)
tree78f826640a52bd66e7e92401af748f7807c1c23d /doc/api-keys.texi
parentssh/key-func.c (guile_ssh_string_to_public_key): Fix a bug (diff)
downloadguile-ssh-121df67f1894fb06f12a1f60ce040b32c73628f6.tar.gz
doc/api-keys.texi (Keys): Improve description of `public-key?'
* doc/api-keys.texi (Keys): Make description of `public-key?' more accurate. * ssh/key-type.c (guile_ssh_is_public_key_p): Update docstring.
Diffstat (limited to 'doc/api-keys.texi')
-rw-r--r--doc/api-keys.texi6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/api-keys.texi b/doc/api-keys.texi
index d757efc..b390279 100644
--- a/doc/api-keys.texi
+++ b/doc/api-keys.texi
@@ -18,8 +18,10 @@ Return @code{#t} if @var{x} is a Guile-SSH key, @code{#f} otherwise.
@end deffn
@deffn {Scheme Procedure} public-key? x
-Return @code{#t} if @var{x} is a Guile-SSH public key, @code{#f}
-otherwise.
+Return @code{#t} if @var{x} is a Guile-SSH key and it @strong{contains} a
+public key, @code{#f} otherwise. What it means is that the procedure will
+return @code{#t} for a private key too (because the private key contains a
+public key in some sense).
@end deffn
@deffn {Scheme Procedure} private-key? x