adds scripting to surpress the "eyebrows" for modules - #141
Merged
Conversation
This isn't the ideal way to to this - it should come from within module, but we want the combination of content to be consistent. We can back this out entirely (cease surpressing or overriding) as upstream content aligns, assuming it'll agree in all cases (swift-testing, for example, may use a different structure when it's published on developer.apple.com) - controlled in navigation.json - per-module overrides possible, but not enabled by default - tests to validate - default (now) to surpress on all for consistency's sake
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
adds scripting to surpress the "eyebrows" for modules
This isn't the ideal way to to this - it should come from within module, but we want the combination of content to be consistent. We can back this out entirely (cease surpressing or overriding) as upstream content aligns, assuming it'll agree in all cases (swift-testing, for example, may use a different structure when it's published on developer.apple.com)
Validation
Local run with all eyebrows suppressed:
swift package generate-documentation --analyze --warnings-as-errorspassesswift package --disable-sandbox preview-documentationBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.