update port-filename docs
authorAndy Wingo <wingo@pobox.com>
Mon, 28 Feb 2011 19:53:40 +0000 (20:53 +0100)
committerAndy Wingo <wingo@pobox.com>
Mon, 28 Feb 2011 19:54:03 +0000 (20:54 +0100)
* doc/ref/api-io.texi (File Ports):
* libguile/ports.c (scm_port_filename): Fix docs to match
  implementation.

doc/ref/api-io.texi
libguile/ports.c

index 52dfdd4..6a50424 100644 (file)
@@ -949,9 +949,8 @@ used only during port creation are not retained.
 
 @deffn {Scheme Procedure} port-filename port
 @deffnx {C Function} scm_port_filename (port)
-Return the filename associated with @var{port}.  This function returns
-the strings "standard input", "standard output" and "standard error"
-when called on the current input, output and error ports respectively.
+Return the filename associated with @var{port}, or @code{#f} if no
+filename is associated with the port.
 
 @var{port} must be open, @code{port-filename} cannot be used once the
 port is closed.
index 6a51ddc..a48cc86 100644 (file)
@@ -1942,9 +1942,8 @@ SCM_DEFINE (scm_set_port_column_x, "set-port-column!", 2, 0, 0,
 
 SCM_DEFINE (scm_port_filename, "port-filename", 1, 0, 0,
             (SCM port),
-           "Return the filename associated with @var{port}.  This function returns\n"
-           "the strings \"standard input\", \"standard output\" and \"standard error\"\n"
-           "when called on the current input, output and error ports respectively.")
+           "Return the filename associated with @var{port}, or @code{#f}\n"
+           "if no filename is associated with the port.")
 #define FUNC_NAME s_scm_port_filename
 {
   port = SCM_COERCE_OUTPORT (port);