-
Notifications
You must be signed in to change notification settings - Fork 129
Specify default code listing language for DocC catalog #85
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Specify default code listing language for DocC catalog #85
Conversation
...ift-openapi-generator/Documentation.docc/Articles/Contributing-to-Swift-OpenAPI-Generator.md
Outdated
Show resolved
Hide resolved
Thanks @denil-ct! Were you able to test that after this addition, when you preview the docs locally, you get syntax highlighting for Swift even for code blocks without the explicit annotation? Would be good to do this, and add this to the Test Plan section of your PR description. |
Yes, I tested it for the one I removed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, to summarize, please just fix these up and we're good to go:
- revert the removal of the explicit listing name in
Contributing-...md
- edit the PR description to say that you tested the change manually by removing one of the annotations and still seeing the syntax highlighting
Thanks!
Hmm that's unfortunate, not sure if expected behavior? cc @ethan-kusters @franklinsch |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR fixes the issue, we'll investigate code listings coming from code comments separately. Looks good, thanks!
@czechboy0 This comment seems to imply this is only applicable for listings within the bundle. |
@swift-server-bot test this please |
Motivation
Resolves #20
Modifications
CDDefaultCodeListingLanguage
to info.plistResult
Swift code blocks no longer needs to be explicitly marked as such.
Test Plan
Files inside the docc archive - Tested and verified with both explicit and non-explicit swift markings.
Files outside the docc archive - TBD