GNU bug report logs -
#10163
Incomplete/vague section of Guile Manual
Previous Next
Reported by: Ryan Fox <ryan <at> rcfox.ca>
Date: Wed, 30 Nov 2011 01:39:02 UTC
Severity: normal
Done: Andy Wingo <wingo <at> pobox.com>
Bug is archived. No further changes may be made.
Full log
View this message in rfc822 format
[Message part 1 (text/plain, inline)]
Your bug report
#10163: Incomplete/vague section of Guile Manual
which was filed against the guile package, has been closed.
The explanation is attached below, along with your original report.
If you require more details, please reply to 10163 <at> debbugs.gnu.org.
--
10163: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=10163
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
Hi Ryan,
Thanks for the report.
On Tue 29 Nov 2011 20:17, Ryan Fox <ryan <at> rcfox.ca> writes:
> /* Check that arg is really a shape SMOB. */
> SCM_VALIDATE_SHAPE (SCM_ARG1, shape);
>
> After some searching, I was able to figure out that the
> function scm_assert_smob_type() is probably the intended behaviour for
> this. However,
> there was no indication of this in the description.
I changed the example and the text to use scm_assert_smob_type. This
entire section could use some modernization and less hand-waving, but
that is a larger project.
Happy hacking,
Andy
--
http://wingolog.org/
[Message part 3 (message/rfc822, inline)]
[Message part 4 (text/plain, inline)]
Hello,
In section 5.7.1.4, "Writing Guile Primitives for Dia" at
http://www.gnu.org/software/guile/manual/guile.html, the description of the
square_p() implementation is incomplete. It uses a macro call to ensure
that the SCM value is a shape, but does not explain what that
implementation is:
/* Check that arg is really a shape SMOB. */
SCM_VALIDATE_SHAPE (SCM_ARG1, shape);
The explanation merely states:
"SCM_VALIDATE_SHAPE is a macro that you should define as part of your SMOB
definition: it checks that the passed parameter is of the expected type."
After some searching, I was able to figure out that the
function scm_assert_smob_type() is probably the intended behaviour for
this. However, there was no indication of this in the description.
As a side note: I'm a new Schemer, so perhaps this isn't idiomatic, but
would it make more sense to use the SCM_SMOB_PREDICATE macro instead? This
way, you can simply return false for any type, even if it isn't a shape.
Asking if a number is a shape (for example) doesn't strike me as
particularly exceptional or incorrect.
Thanks,
Ryan Fox
[Message part 5 (text/html, inline)]
This bug report was last modified 13 years and 205 days ago.
Previous Next
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.