Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Problems with export -format rst interface-reference #1435

Open
cgay opened this issue May 24, 2022 · 1 comment
Open

Problems with export -format rst interface-reference #1435

cgay opened this issue May 24, 2022 · 1 comment
Labels

Comments

@cgay
Copy link
Member

cgay commented May 24, 2022

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 cgay added the Docs label May 24, 2022
@cgay cgay changed the title export -format rst interface-reference Problems with export -format rst interface-reference May 15, 2023
@cgay
Copy link
Member Author

cgay commented May 15, 2023

  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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant