[Doc] API documentation updates. #23069
Merged
+43
−14
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
mhong
approved these changes
Mar 4, 2019
| /// | ||
| /// - Parameter numpyArray: The `numpy.ndarray` instance to convert. | ||
| /// - Precondition: The `numpy` Python package must be installed. | ||
| /// - Precondition: `numpyArray` must be 1-D and have a compatible scalar |
There was a problem hiding this comment.
do you want to more explicitly describe when a nil value will be returned? Same for other APIs below.
Precondition usually describes cases where the code will lead to undefined behavior (e.g. crash) when the condition is violated.
There was a problem hiding this comment.
+1. Precondition is definitely not the right term for describing nil. We should look at how common failable initializers are documented in the standard library.
There was a problem hiding this comment.
Thanks for great catch!
A Returns: comment is typically used to describe failable initializers and when they return nil.
Updated in e7920e4, following this stdlib documentation.
rxwei
approved these changes
Mar 4, 2019
|
@swift-ci Please test tensorflow |
mhong
approved these changes
Mar 4, 2019
rxwei
pushed a commit
to rxwei/swift
that referenced
this pull request
May 11, 2019
* [Doc] API documentation updates.
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.
Assorted documentation updates.