Skip to content
This repository was archived by the owner on Jul 1, 2023. It is now read-only.

Improve API documentation. #114

Merged
merged 1 commit into from
Apr 24, 2019

Conversation

dan-zheng
Copy link
Member

  • Standardize documentation for func call(_:).
  • Minor edits to RNN docs.

- Standardize documentation for `func call(_:)`.
- Minor edits to RNN docs.
@dan-zheng dan-zheng requested a review from rxwei April 23, 2019 23:39
@@ -1329,7 +1307,7 @@ public struct SimpleRNNCell<Scalar: TensorFlowFloatingPoint>: RNNCell, VectorNum
}
}

/// An LSTM Cell.
/// An LSTM cell.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be A LSTM cell ?

Copy link
Contributor

@rxwei rxwei Apr 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since people tend to pronounce the acronym directly, the pronunciation starts with a vowel, so "An" would be most appropriate.

Copy link
Contributor

@rxwei rxwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rxwei rxwei merged commit 17c58d7 into tensorflow:master Apr 24, 2019
Shashi456 pushed a commit to Shashi456/swift-apis that referenced this pull request Apr 29, 2019
- Standardize documentation for `func call(_:)`.
- Minor edits to RNN docs.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants