-
Notifications
You must be signed in to change notification settings - Fork 482
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
compact index #254
Comments
If an index is quite lengthy then I'd assume it would be more readable as a formatted list rather than a compacted comma-separated paragraph. Note that you can already split lengthy |
yeah, I find myself a little torn on this: a formatted list is better suited for accurate scrutiny, while a compact paragraph is more suited for a quick glance, it conveys faster the big picture. I would give the opportunity for Documenter's user to choose among the two, if it is easy to implement and if there some precedent to it (I don't know of any). |
Yeah, I don't think this is a particularly high priority, but if anyone wants/needs this they're welcome to take a crack at it and we can see how it looks. |
I'm doing a triage of open documenter issues and closing issues that are stale. If I've made a mistake, please re-open Closing as stale. This doesn't seem like a high priority, and no one else has complained about it. I'd suggest that there are usually better ways of communicating the documentation to users that a paragraph with a list of names. (Even the index as a list isn't great.) |
Sometimes an Index can be quite lengthy (see http://juliagraphs.github.io/LightGraphs.jl/latest/basicmeasures/). Could it be more convenient to have the names displayed in a (horizzontal) string and without the module prefix (#253)?
The text was updated successfully, but these errors were encountered: