mirror of
https://git.savannah.gnu.org/git/guile.git
synced 2025-05-20 19:50:24 +02:00
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:
parent
6a94e6e1ae
commit
ac012a27a2
2 changed files with 4 additions and 6 deletions
|
@ -949,9 +949,8 @@ used only during port creation are not retained.
|
||||||
|
|
||||||
@deffn {Scheme Procedure} port-filename port
|
@deffn {Scheme Procedure} port-filename port
|
||||||
@deffnx {C Function} scm_port_filename (port)
|
@deffnx {C Function} scm_port_filename (port)
|
||||||
Return the filename associated with @var{port}. This function returns
|
Return the filename associated with @var{port}, or @code{#f} if no
|
||||||
the strings "standard input", "standard output" and "standard error"
|
filename is associated with the port.
|
||||||
when called on the current input, output and error ports respectively.
|
|
||||||
|
|
||||||
@var{port} must be open, @code{port-filename} cannot be used once the
|
@var{port} must be open, @code{port-filename} cannot be used once the
|
||||||
port is closed.
|
port is closed.
|
||||||
|
|
|
@ -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_DEFINE (scm_port_filename, "port-filename", 1, 0, 0,
|
||||||
(SCM port),
|
(SCM port),
|
||||||
"Return the filename associated with @var{port}. This function returns\n"
|
"Return the filename associated with @var{port}, or @code{#f}\n"
|
||||||
"the strings \"standard input\", \"standard output\" and \"standard error\"\n"
|
"if no filename is associated with the port.")
|
||||||
"when called on the current input, output and error ports respectively.")
|
|
||||||
#define FUNC_NAME s_scm_port_filename
|
#define FUNC_NAME s_scm_port_filename
|
||||||
{
|
{
|
||||||
port = SCM_COERCE_OUTPORT (port);
|
port = SCM_COERCE_OUTPORT (port);
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue