opendylan icon indicating copy to clipboard operation
opendylan copied to clipboard

Problems with export -format rst interface-reference

Open cgay opened this issue 3 years ago • 1 comments

The interface-reference report has some problems determining the correct library and module names. I ran the report for the collection-extensions library and it has two problems I've noticed so far:

  1. Classes in the Dylan library are output as :class:<foo> rather than :drm:<foo> even though the report attempts to do the latter, so there's a bug in the logic of rst-xref-definition-name where it compares the library name to "dylan". (In that function lib has to be true, else we would see the problem below...

  2. The type <insert-entry> is output as follows

    ``{<insert-entry> in sequence-diff}``
    

    Since sequence-diff is the current module for this output it should just be

    :class:`<insert-entry>`
    

cgay avatar May 24 '22 16:05 cgay

  1. It generates an entry for names that are re-exported from the module, but there's no indication that they are in fact defined elsewhere and just re-exported. For example, the report for common-dylan contains
.. generic-function:: ^
   :open:

   :signature: ^ (x y) => (#rest values)

   :parameter x: An instance of :class:`<object>`.
   :parameter y: An instance of :class:`<object>`.
   :value #rest values: An instance of :class:`<object>`.

even though ^ is owned by the dylan library.

cgay avatar May 15 '23 03:05 cgay