Refactor generateToc.ts to not use dictionary type #1259
Merged
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
Eric-Arellano
commented
Apr 30, 2024
|
|
||
| if (itemModuleTitle) { | ||
| const itemModule = tocModulesByTitle[itemModuleTitle]; | ||
| const itemModule = tocModulesByTitle.get(itemModuleTitle) as TocEntry; |
Collaborator
Author
There was a problem hiding this comment.
We can be confident .get() works because itemModuleTitle uses tocModuleTitles, which is all the .keys() of tocModulesByTitle.
frankharkins
approved these changes
Apr 30, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Prework for Qiskit#1256. It was confusing how we pass both `tocModules: TocEntry[]` and `tocModulesByTitle: Dictionary<TocEntry>`. It wasn't clear how those values relate, and `Dictionary` is an under-documented API by Lodash. Also adds `hasPrefix`, which we will need in Qiskit#1256.
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.
Prework for #1256. It was confusing how we pass both
tocModules: TocEntry[]andtocModulesByTitle: Dictionary<TocEntry>. It wasn't clear how those values relate, andDictionaryis an under-documented API by Lodash.Also adds
hasPrefix, which we will need in #1256.