update port-filename docs

* doc/ref/api-io.texi (File Ports):
* libguile/ports.c (scm_port_filename): Fix docs to match
  implementation.
This commit is contained in:
Andy Wingo 2011-02-28 20:53:40 +01:00
commit ac012a27a2
2 changed files with 4 additions and 6 deletions

View 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.