---
name: Documentation Issue
about: Use this template for documentation related issues

---

<em>Please make sure that this is a documentation issue. As per our [GitHub Policy](https://github.com/tensorflow/tensorflow/blob/master/ISSUES.md), we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub. tag:doc_template</em>


**System information**
- TensorFlow version:
- Doc Link:


**Describe the documentation issue**

**We welcome contributions by users. Will you be able to update submit a PR (use the [doc style guide](https://www.tensorflow.org/community/documentation)) to fix the doc Issue?**

---
name: Documentation Issue
about: Use this template for documentation related issues

---

<em>Thanks so much for taking the time to file a documentation issue and even more thanks if you intend to contribute to updating it! Please do introduce yourself on our Mailing List via [Google Groups](https://groups.google.com/a/tensorflow.org/forum/#!forum/docs) or [email](mailto:docs@tensorflow.org list) and let us know if you have any questions. We also encourage you to review our [Documentation Contributor Guide](https://www.tensorflow.org/community/contribute/docs). As a side note, per our [GitHub Policy](https://github.com/tensorflow/tensorflow/blob/master/ISSUES.md), we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub. tag:doc_template</em>

## Existing URLs containing the issue:
Link to the documentation entry, for example: https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/MyMethod

## Description of issue (what needs changing):

### Correct Links
Is the link pointing to the source code correct? To find the source code, use `git grep my_method` from the git command line in your locally checked out repository.

### Clear Description
Why should someone use this method? How is it useful?

### Usage Example
Is there a usage example?

### Parameters Defined
Are all arguments that can be passed in defined and formatted correctly?

### Returns Defined
Are return values defined?

### Raises Listed and Defined
Are errors defined? [Example](https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/feature_column/categorical_column_with_vocabulary_file#raises)

### Request Visuals, if Applicable
Are there currently visuals? If not, would they make the content clearer?

### Submit PR?
Are you planning to also submit a [Pull Request](https://help.github.com/en/articles/about-pull-requests) to fix this issue? See the [Documentation Contributor Guide](https://www.tensorflow.org/community/contribute/docs) the [Documentation Style Guide](https://www.tensorflow.org/community/contribute/docs_style).

Update documentation template to match recommendations from doc sprints
Update documentation template to match recommendations from doc sprints
