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

Document: Fix the definition of defmodule/incl. #1163

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

NoahStoryM
Copy link
Contributor

In the old definition, if we search for JSExpr in the search manuals, we will get:
JSExpr provided from typed/racket/base, typed/racket

instead of
JSExpr provided from typed/json

@samth
Copy link
Member

samth commented Nov 8, 2021

I don't think this is the right fix -- it's equivalent to just taking out the section.

@NoahStoryM
Copy link
Contributor Author

I'm not sure about the purpose of introducing section in defmodule/incl, but I tried deleting #:style in these two definitions to ensure that the section is valid:

@(define-syntax-rule @defmodule/incl[name rest ...]
    (list
     (section (string-append "Typed for "(symbol->string'name)))
     @defmodule[name rest ...]))

@(define-syntax-rule @defmodule/incl[name rest ...]
    (begin
      (section (string-append "Typed for "(symbol->string'name)))
      @defmodule[name rest ...]))

It seems that these two definitions both make the document generate the corresponding section. Have I missed something? I am not very familiar with scribble.

@NoahStoryM
Copy link
Contributor Author

NoahStoryM commented Nov 9, 2021

By the way, can we consider adding @section{Typed for the @racketfont{typed} collection} and using

(subsection #:style '(hidden) (symbol->string 'name))

instead of

(section #:style '(hidden toc-hidden unnumbered)
         (string-append "Typed for " (symbol->string 'name)))

I think it might be better to list these typed collections in the catalog, just like we list Types in Type Reference.

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

Successfully merging this pull request may close these issues.

2 participants