Skip to content
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

Add request argument to opt-out of source file path information #526

Merged

Conversation

d-ronnqvist
Copy link
Contributor

@d-ronnqvist d-ronnqvist commented Mar 30, 2023

Bug/issue #, if applicable: rdar://107075861

Summary

This adds an argument to ConvertRequest to allow opting out of source file URI information for requests that don't need or want that information.

Dependencies

None

Testing

Generate documentation for a symbol using the ConvertService API and configure emitSymbolSourceFileURIs to false in the request.

The render node in the response should not have its metadata.remoteSource property set.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

@d-ronnqvist
Copy link
Contributor Author

@swift-ci please test

@d-ronnqvist d-ronnqvist merged commit 5f159cb into swiftlang:main Mar 31, 2023
d-ronnqvist added a commit to d-ronnqvist/swift-docc that referenced this pull request Mar 31, 2023
d-ronnqvist added a commit that referenced this pull request Mar 31, 2023
@d-ronnqvist d-ronnqvist deleted the convert-service-skip-source-repository branch February 19, 2024 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants