[Doc] Move public TensorFlow runtime APIs to new file. #23032
Merged
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
Move public APIs from `CompilerRuntime.swift` to new file `Execution.swift`. This clearly separates user-exposed public functions from compiler internals. This separation also benefits `jazzy` API doc generation: `jazzy` can simply skip doc generation for the entire `CompilerRuntime.swift` file. Otherwise, per-declaration `/// :nodoc:` annotations would be necessary for skipping documentation.
mhong
reviewed
Mar 1, 2019
Address feedback from @mhong.
Contributor
Author
|
@swift-ci Please test tensorflow |
rxwei
pushed a commit
to rxwei/swift
that referenced
this pull request
May 11, 2019
* [Doc] Move public TensorFlow runtime APIs to new file. Move public APIs from `CompilerRuntime.swift` to new file `Execution.swift`. This clearly separates user-exposed public functions from compiler internals. This separation also benefits `jazzy` API doc generation: `jazzy` can simply skip doc generation for the entire `CompilerRuntime.swift` file. Otherwise, per-declaration `/// :nodoc:` annotations would be necessary for skipping documentation. * Add clarification comment to `CompilerRuntime.swift`. Address feedback from @mhong. * Improve clarification comment.
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.
Move public APIs from
CompilerRuntime.swiftto new fileExecution.swift.This clearly separates user-exposed public functions from compiler internals.
This separation also benefits
jazzyAPI doc generation:jazzycan simplyskip doc generation for the entire
CompilerRuntime.swiftfile. Otherwise,per-declaration
/// :nodoc:annotations would be necessary for skippingdocumentation.