Added warnings for multiple root pages #1187
Closed
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.
Summary
The implementation in DocumentationContext.swift is correctly handling all three warning scenarios for multiple root pages:
Testing
All tests for the DocumentationContext_RootPageTests have passed successfully!
swift test --filter DocumentationContext_RootPageTests
This test verifies that the system correctly identifies and warns when documentation contains symbol graphs for multiple modules.
testMultipleSymbolGraphModulesWarning - PASSED
This test confirms that warnings are correctly emitted when documentation contains both a symbol graph module and a manual technology root article with the @TechnologyRoot directive.
testMixedRootTypesWarning - PASSED
This test validates that the system properly identifies and warns when documentation contains multiple manual technology roots.
testMultipleTechnologyRootsWarning - PASSED
Steps:
swift test --filter DocumentationContext_RootPageTests.testMultipleSymbolGraphModulesWarning
swift test --filter DocumentationContext_RootPageTests.testMixedRootTypesWarning
swift test --filter DocumentationContext_RootPageTests.testMultipleTechnologyRootsWarning
Checklist
./bin/test
script and it succeededIt would be greatly appreciated if you could review the code once @d-ronnqvist . I have attempted to implement the previous feedback and made some local modifications. Please inform me if there are any suggestions or if the code is not functioning as intended. This is my first GitHub contribution to an organization repository, and I’m eager to learn from any mistakes.