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

Spurious section headers in custom categories #780

Open
reitzig opened this issue Apr 24, 2017 · 6 comments
Open

Spurious section headers in custom categories #780

reitzig opened this issue Apr 24, 2017 · 6 comments

Comments

@reitzig
Copy link

reitzig commented Apr 24, 2017

I collect symbols in custom categories. Despite the fact that they are all public, I get "Public" headers in the index list.

Exhibit A:
screen shot 2017-04-24 at 17 45 23

Exhibit B:
screen shot 2017-04-24 at 17 45 31

I also note that entries have different distances between them, which just looks odd.

@reitzig
Copy link
Author

reitzig commented Apr 24, 2017

Ah, my bad; these are // MARK: comments in our code. But why on earth are they included in these indices? They are far away from the declarations they accompany here in the index, and are used to organize files, not documentation categories.

I think MARKs should be dropped from indices of custom categories.

The bigger gaps coincide with the beginnings of new files. That also makes little sense in custom categories: symbols may share a file but not the documentation category, or vice versa.

@johnfairh
Copy link
Collaborator

Continuing down the 'css kludges' path, these 'mark:' derived lines are in a div styled "task-name-container" so can be hidden like the others.

@reitzig
Copy link
Author

reitzig commented Apr 26, 2017

Alas, it does not seem possible to distinguish site types. I want the MARKs in class views (they make sense there). I only want to hide them in custom categories where you get a really weird mix; note how arbitrary the task-group divs are (if you mix symbols from different files and/or order them differently than in the files)!

@johnfairh
Copy link
Collaborator

Splice in <style>.task-name-container {display: none;}</style> just before </head> of the pages you care about? (yuck! I'm done now.)

@reitzig
Copy link
Author

reitzig commented Apr 26, 2017

I won't consider manual approaches; any workaround needs to be scripted. Since I don't see a way to identify indices of custom-category section pages, this won't work. :/ Thanks, anyway.

@johnfairh
Copy link
Collaborator

I noticed Siesta uses custom categories + strategically placed MARK comments to good effect. An enhancement here then could be to drop the auto MARK and add the ability to add section headers instead via the config file.

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

No branches or pull requests

2 participants