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

pseudo-heading (right-aligned tag) #110

Open
justinmk opened this issue Jun 26, 2023 · 4 comments
Open

pseudo-heading (right-aligned tag) #110

justinmk opened this issue Jun 26, 2023 · 4 comments
Labels
enhancement New feature or request

Comments

@justinmk
Copy link
Member

justinmk commented Jun 26, 2023

Problem

vim :help (including :help api) has many "pseudo headers" that look like:

range({spec})                                            *vim.version.range()*
    Parses a semver |version-range| "spec" and returns a range object:  
    ...

Expected behavior

Treat right-aligned tags as h3? This is necessary so that "flow" layout doesn't join the lines. In the above example,

  • the range({spec})... line should be a h3 heading.
  • the Parses a semver... line should start a new block.
@justinmk justinmk added the enhancement New feature or request label Jun 26, 2023
@justinmk justinmk changed the title pseudo-header (right-aligned tag) pseudo-heading (right-aligned tag) Jun 26, 2023
@clason
Copy link
Member

clason commented Jun 26, 2023

Maybe h4 would be a better fit?

@justinmk
Copy link
Member Author

justinmk commented Jun 26, 2023

maybe, depends on whether these headings are usually nested below h2 or h3? h3 is pretty uncommon so I was thinking that it's too granular to treat these as h4.

@clason
Copy link
Member

clason commented Jun 26, 2023

Wait, you think there's consistent hierarchy in how these are used in the docs? :D

I guess my thinking was more if there's an h3, then h4 will lead to better hierarchy, and if there is not, it's still correct (even if a heading is skipped).

@clason
Copy link
Member

clason commented Jun 26, 2023

(To be clear, if the gen_help_html script requires h3 specifically, my comment is moot.)

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

No branches or pull requests

2 participants