20-documentation-issue.md

name	about
Documentation Issue	Use this template for documentation related issues

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 with Google Groups or email and let us know if you have any questions. We also encourage you to review our Documentation Contributor Guide. As a side note, per our GitHub Policy, we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub. tag:doc_template

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

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 to fix this issue? See the Documentation Contributor Guide the Documentation Style Guide.