experiments/STT-tensorflow
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #28319 from missaugustina:update-doc-issues-template

Browse Source 
PiperOrigin-RevId: 246534153
This commit is contained in:
TensorFlower Gardener 2019-05-03 11:20:30 -07:00
commit 56764feeb6
1 changed files with 53 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
.github/ISSUE_TEMPLATE/20-documentation-issue.md vendored
View File

@ -4,14 +4,61 @@ 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>
<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 with
[Google Groups](https://groups.google.com/a/tensorflow.org/forum/#!forum/docs)
or [email](mailto:docs@tensorflow.org) 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:
**System information**
- TensorFlow version:
- Doc Link:
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):
**Describe the documentation issue**
### Correct Links
**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?**
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).