Show packages and libraries in the breadcrumbs #1190
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
|
This change requires a change in sherlodoc, likely due to the change in the identifier type. Do you have a branch with the required modification, so that I can test this PR? |
This function is a bad alias to `string_of_kind` and gets in the way of grepping.
The `is_dir` function has only two purposes and is hard to maintain in the several places where it's defined. For example, when the identifier type changes. Use a pair of booleans and move its definition into the Url module instead.
The new constructor identify which part of the identifier is not just a page but a library. This will be used to propagate the information to breadcrumbs.
This makes the breadcrumbs more readable by removing unteresting components and make the beginning of the module path more recognizable.
Julow
force-pushed
the
breadcrumbs_library
branch
from
3125314 to
a7aedca
Compare
Collaborator
Author
|
Oops I forgot about that. Here's the fix: jonludlam/sherlodoc#1 (branch |
Collaborator
Author
|
I'll put this PR as a draft while I work a bit more on breadcrumbs to be sure it's the right direction. We'll have to propagate the "short title" of pages into the breadcrumbs, also for package and library index pages, and I don't know if this change will still be required for that. |
Collaborator
Author
|
Closing as this is probably not the right approach. Maybe #1196 is better. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is still work in progress as pages that are inside a library are not recognized and the library name might be inconsistent with the one passed to the link command.
This makes the breadcrumbs more readable by removing uninterested components and make the beginning of the module path more recognizable.
The
`Libraryconstructor is added to identifiers to propagate this information.