From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Zelphir Kaltstahl Newsgroups: gmane.lisp.guile.user Subject: eof-object? documentation Date: Sun, 15 Nov 2020 13:15:03 +0100 Message-ID: <7055fbb7-35ee-1748-4846-2db529341aea@posteo.de> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="20236"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.10.0 To: Guile User Original-X-From: guile-user-bounces+guile-user=m.gmane-mx.org@gnu.org Sun Nov 15 13:15:28 2020 Return-path: Envelope-to: guile-user@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1keGwJ-0005Ak-OM for guile-user@m.gmane-mx.org; Sun, 15 Nov 2020 13:15:27 +0100 Original-Received: from localhost ([::1]:56958 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1keGwI-0004nB-J9 for guile-user@m.gmane-mx.org; Sun, 15 Nov 2020 07:15:26 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:34220) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1keGw6-0004n1-JD for guile-user@gnu.org; Sun, 15 Nov 2020 07:15:14 -0500 Original-Received: from mout01.posteo.de ([185.67.36.65]:33174) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1keGw2-0004Sc-Il for guile-user@gnu.org; Sun, 15 Nov 2020 07:15:13 -0500 Original-Received: from submission (posteo.de [89.146.220.130]) by mout01.posteo.de (Postfix) with ESMTPS id A84EE16005F for ; Sun, 15 Nov 2020 13:15:04 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.de; s=2017; t=1605442504; bh=SDt3JhmIDovvmhtn5ut81tlcdRg0QapOfN0OClJ17Lk=; h=To:From:Subject:Date:From; b=kdSKFmJcgxImJYBDoV+kRSuyTpXFxiD6dKs4nRSgjfVAgze83GSvjhLvWD2M5wQET W/10IsmskGtqB32kdVNYFpeUGumQUeOJMQeB1nDMtTWKdHtAPNyxkMXTl+G9PnCihr OCOOOlQXJ/D6ud+MKHWx3bR6bhWIG14d9vxEx6FNRlRi3stGCw1dr1w042OJxfF6sY gOZe0fra/8m0+D+oJLq93fvszXLPQYC7gkeM0ihB/Rv3Rw0rfIsgNmpjuRMXG+m4k3 EWWHs6vJGjFlHpRIIo89hxcBC7jFQxeGgRE0G7iGXdg4j9IzqfohUjb6JrVk++hK2r D5Qu84rowHfuw== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4CYrkJ0zs2z6tm9 for ; Sun, 15 Nov 2020 13:15:03 +0100 (CET) Content-Language: en-US Received-SPF: pass client-ip=185.67.36.65; envelope-from=zelphirkaltstahl@posteo.de; helo=mout01.posteo.de X-detected-operating-system: by eggs.gnu.org: First seen = 2020/11/15 05:14:11 X-ACL-Warn: Detected OS = Linux 3.11 and newer [fuzzy] X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H4=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: guile-user@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: General Guile related discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guile-user-bounces+guile-user=m.gmane-mx.org@gnu.org Original-Sender: "guile-user" Xref: news.gmane.io gmane.lisp.guile.user:17022 Archived-At: Hello Guile users! I noticed a mistake in the documentation at https://www.gnu.org/software/guile/manual/html_node/Binary-I_002fO.html. There it says: "To use these routines, first include the binary I/O module: (use-modules (ice-9 binary-ports))" and then it lists `eof-object?`, which implies, that this procedure is in the `(ice-9 binary-ports)` module. However, it is available without importing that module and not available, when only importing the module as follows: ~~~~ $ guile GNU Guile 3.0.4 Copyright (C) 1995-2020 Free Software Foundation, Inc. Guile comes with ABSOLUTELY NO WARRANTY; for details type `,show w'. This program is free software, and you are welcome to redistribute it under certain conditions; type `,show c' for details. Enter `,help' for help. scheme@(guile-user)> (library (file-utils) (export) (import (except (rnrs base) let-values map error) (only (guile) lambda* λ call-with-input-file call-with-output-file set-port-encoding! ;; this is documented to be in (ice-9 binary-ports) but it is not #;eof-object?) ;; for textual reading and writing procedures (ice-9 textual-ports) ;; not sure if needed (ice-9 binary-ports) ;; for `eof-object?` (ice-9 rdelim) ;; srfi-1 for list procedures (srfi srfi-1))) scheme@(file-utils)> eof-object Display all 338 possibilities? (y or n) scheme@(file-utils)> eof-object? ;;; : warning: possibly unbound variable `eof-object?' ice-9/boot-9.scm:1669:16: In procedure raise-exception: Unbound variable: eof-object? Entering a new prompt. Type `,bt' for a backtrace or `,q' to continue. scheme@(file-utils) [1]> ~~~~ However, the procedure `eof-object` (no trailing question mark) is available: ~~~~ $ guile GNU Guile 3.0.4 Copyright (C) 1995-2020 Free Software Foundation, Inc. Guile comes with ABSOLUTELY NO WARRANTY; for details type `,show w'. This program is free software, and you are welcome to redistribute it under certain conditions; type `,show c' for details. Enter `,help' for help. scheme@(guile-user)> (library (file-utils) (export) (import (except (rnrs base) let-values map error) (only (guile) lambda* λ call-with-input-file call-with-output-file set-port-encoding! ;; this is documented to be in (ice-9 binary-ports) but it is not #;eof-object?) ;; for textual reading and writing procedures (ice-9 textual-ports) ;; not sure if needed (ice-9 binary-ports) ;; for `eof-object?` (ice-9 rdelim) ;; srfi-1 for list procedures (srfi srfi-1))) scheme@(file-utils)> eof-object $1 = # scheme@(file-utils)> ~~~~ which is not available when not doing the imports like that and simply calling guile and trying to access it: ~~~~ $ guile GNU Guile 3.0.4 Copyright (C) 1995-2020 Free Software Foundation, Inc. Guile comes with ABSOLUTELY NO WARRANTY; for details type `,show w'. This program is free software, and you are welcome to redistribute it under certain conditions; type `,show c' for details. Enter `,help' for help. scheme@(guile-user)> eof-object ;;; : warning: possibly unbound variable `eof-object' ice-9/boot-9.scm:1669:16: In procedure raise-exception: Unbound variable: eof-object Entering a new prompt. Type `,bt' for a backtrace or `,q' to continue. scheme@(guile-user) [1]> ~~~~ If you could point me to where and how to update the docs, I could probably take away that `?`. Not sure what is involved in the process of fixing the docs. Regards, Zelphir -- repositories: https://notabug.org/ZelphirKaltstahl