Fix rare crash when tutorial file has same as documentation bundle identifier #517
Conversation
| @@ -67,9 +67,9 @@ final class PathHierarchyBasedLinkResolver { | |||
|
|
|||
| /// Map the resolved identifiers to resolved topic references for a given bundle's article, tutorial, and technology root pages. | |||
| func addMappingForRoots(bundle: DocumentationBundle) { | |||
| resolvedReferenceMap[pathHierarchy.tutorialContainer.identifier] = bundle.tutorialsRootReference | |||
There was a problem hiding this comment.
The root cause for this crash is that I had forgotten which is the "tutorial" page and which is the "technology" page so the tutorial link resolved the reference for the technology page and vice versa resulting in an assertion during rendering of the See Also section.
There was a problem hiding this comment.
should we rename these so that they are easier to distinguish?
There was a problem hiding this comment.
I think that's a good idea. There are still many places that use the "technology" terminology in the code and I think we should update them all to match the user-facing terminology.
I opened this issue about updating the general "technology" terminology in the code.
|
@swift-ci please test |
|
@swift-ci please test |
|
@swift-ci please test |
|
@swift-ci please test |
…entifier (swiftlang#517) * Fix crash when tutorial named like module/bundle is curated w/ symbol rdar://106958656 * Fix test that was always passing and update misleading comments in test
Bug/issue #, if applicable: rdar://106958656
Summary
This fixes a rare crash when a tutorial file name is the same as the documentation bundle identifier and that tutorial is curated together with a symbol from the module with the same name.
In other words; in the documentation for the "Something" module, where no bundle identifier is specified, the bundle identifier is inferred from the bundle name which is inferred from the module name. Here, the module name, bundle name, and bundle identifier are all "Something". If this documentation also contains a tutorial overview in a file named "Something.tutorial", curating this tutorial in the same topic section as a symbol from the "Something" module would crash.
Dependencies
None.
Testing
Build the documentation for SlothCreator. The page for the Sloth symbol should have a tutorial in its generated See Also section.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded[ ] Updated documentation if necessary