Addons: Build doctest to test python docstrings

Created on 8 Oct 2019  路  5Comments  路  Source: tensorflow/addons

Seems that core TF has already used doctest to test python docstring, which having different style with ours, especially for code snippet example usage. To unify the docstring and for better documentation, the doctest should be also built in addons.

See https://www.tensorflow.org/community/contribute/docs_ref for more details.

build documentation good first issue help wanted

All 5 comments

I am interested in helping out with this. Do you have any advice for me on where to start? Thanks!

Hi @bryanko1! Welcome to addons. There is already a PR for this:
https://github.com/tensorflow/addons/pull/677

Would you mind giving it a review?

Yeah, sure thing!

Hello friend, I see this issue is not closed yet, do we still need some help here? @seanpmorgan

Was this page helpful?
0 / 5 - 0 ratings

Related issues

maziyarpanahi picture maziyarpanahi  路  3Comments

seanpmorgan picture seanpmorgan  路  4Comments

facaiy picture facaiy  路  3Comments

seanpmorgan picture seanpmorgan  路  3Comments

ConnorBarnhill picture ConnorBarnhill  路  3Comments