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

manual class sections lack a <h3> title #57

Open
spdegabrielle opened this issue Dec 31, 2023 · 0 comments
Open

manual class sections lack a <h3> title #57

spdegabrielle opened this issue Dec 31, 2023 · 0 comments

Comments

@spdegabrielle
Copy link
Member

Class sections lack a <h3> title

neither
@include-section["color-class.scrbl"] in https://github.com/racket/draw/blob/master/draw-doc/scribblings/draw/draw.scrbl
or @defclass/title[color% object% ()]{ in https://github.com/racket/draw/blob/master/draw-doc/scribblings/draw/color-class.scrbl
does not cause a title for the section to be generated

but the first section 1. Overview does have a title

https://github.com/racket/draw/blob/master/draw-doc/scribblings/draw/guide.scrbl
@title[#:tag "overview"]{Overview}


As I wrote this issue I found

This form is normally used to create a section to be rendered on its own HTML. The 'hidden style is used because the definition box serves as a title.

https://docs.racket-lang.org/scribble/doc-classes.html#%28form._%28%28lib._scribble%2Fmanual..rkt%29._defclass%2Ftitle%29%29

So maybe this is intentional?

I'd prefer a <h3> heading "6 class%" followed by the definition box but I'm guessing that adding @title[#:tag "color%"]{color%} is the wrong way to achieve this. (I'm assuming it is desirable)

The other option would be to change
(list* (title #:style 'hidden (to-element (decl-name decl)))
to
(list* (title #:style #f (to-element (decl-name decl)))
but that would also affect defmixin/title and definterface/title.


PS I noticed this because I went looking to click the title to find the manual source like I could do for section 1:
image

  • there is a 6.1 Equality heading
image
  • there is no 6 colour% heading
image
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

No branches or pull requests

1 participant