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

Commit 57528b6

Browse files
committed
added docstring link
1 parent 9853bd1 commit 57528b6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

governance/api-reviews.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ all possible these docstrings should have runnable examples, and these examples
5454
should form a doctest so they stay correct. The examples should demonstrate an
5555
end-to-end user workflow, such that it’s clear how to generate the necessary
5656
inputs for the API and what to do with the outputs. The docstring should be
57-
understandable by someone who is not familiar with TF.
57+
understandable by someone who is not familiar with TF. See the [guide to writing
58+
TF docstrings](https://www.tensorflow.org/community/contribute/docs_ref) for
59+
more information.
5860

5961
Our documentation generator for classes only sees methods, so prefer defining
6062
members as properties instead of assigning them in `__init__`.

0 commit comments

Comments
 (0)