docstrings.lisp, texinfo macros, plus &whole and &environment

Bug #543935 reported by mon_key
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
SBCL
Won't Fix
Low
Douglas Katzman

Bug Description

missing texinfo macros for `&whole' and `&environment

The texinfo macros in the auto-generated file:
/doc/manual/sbcl.texinfo

for the `@&' do not generate for `&whole' and `&environment' e.g.

,----
| @macro &whole
| &whole
| @end macro
|
| @macro &environment
| &environment
| @end macro
`----

While this may not be a bug if/when these do not appear in SBCL docstrings their
provision in docstrings.lisp would benefit third party tools (such as
alexandria) wich rely on sb-texinfo's docdumping utilities.

/s_P\

Revision history for this message
Nikodemus Siivola (nikodemus) wrote :

sbcl.texinfo is not autogenerated, but rather a part of the manually maintained connective tissue.

Also, &whole and &environment should not appear in documentation at all as they are not part of the interface: their presence in the lambda-list should not matter to the user. If anything, docstrings.lisp should make sure not to have them in its output at all. :)

Additionally, it would be good if docstrings.lisp did spit out an ifnottex.texinfo include instead of forcing it to be copy-pasted everywhere.

summary: - missing texinfo macros for `&whole' and `&environment
+ docstrings.lisp, texinfo macros, plus &whole and &environment
Changed in sbcl:
status: New → Confirmed
importance: Undecided → Low
Revision history for this message
Douglas Katzman (dougk) wrote :

I concur with Nikodemus - &WHOLE and &ENVIRONMENT are not part of an interface contract nor should they appear in docstrings or introspectable lambda lists. And I'm almost done making it so.

Changed in sbcl:
assignee: nobody → Douglas Katzman (dougk)
Revision history for this message
Douglas Katzman (dougk) wrote :

I vaguely recall having removed all &WHOLE and &ENVIRONMENT from advertised lambda lists.
Since the bug is asking for texinfo on them, it's a wont-fix.
This can be reopened if something is wrong about my understanding of the situation,

Changed in sbcl:
status: Confirmed → Won't Fix
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.