Add a note about an open issue with code generation and SourceKit-LSP #642
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
Following the discussion on Slack, this adds a note for users of SourceKit-LSP that the default code generation might not work as expected. https://swift-open-source.slack.com/archives/C02PV8T5HQD/p1726815970093299
|
Thanks for putting this up. IMO I think we should move this to the Supported platforms and minimum versions section, since that's where we're explaining the required runtime and development environments. This is additional note on Editor Support. Additionally, we try to keep the README and root DocC page in sync. Would you be able to update both? |
czechboy0
requested changes
Nov 22, 2024
|
Sorry forgot about this one, updated the PR. |
czechboy0
reviewed
Nov 22, 2024
Sources/swift-openapi-generator/Documentation.docc/Swift-OpenAPI-Generator.md
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Following the discussion on Slack, this adds a note for users of SourceKit-LSP informing them that the default code generation might not work as expected and offers a possible workaround.
https://swift-open-source.slack.com/archives/C02PV8T5HQD/p1726815970093299
Only updates documentation. Let me know if you feel this is the right place for this information?