Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
raviqqe committed Dec 24, 2016
1 parent a7690d7 commit f86abc0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ run(model_fn, train_input_fn, eval_input_fn=None)
add_flag(name, *args, **kwargs)
Add a flag.
Added flags can be accessed by `FLAGS` global variable.
(e.g. `FLAGS.my_flag_name`)
Args:
name: Flag name. Real flag name will be `"--{}".format(name)`.
*args, **kwargs: The rest arguments are the same as
Expand Down
5 changes: 5 additions & 0 deletions docs/qnd/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1053,6 +1053,8 @@ <h2 class="section-title" id="header-functions">Functions</h2>


<div class="desc"><p>Add a flag.</p>
<p>Added flags can be accessed by <code>FLAGS</code> global variable.
(e.g. <code>FLAGS.my_flag_name</code>)</p>
<p>Args:
name: Flag name. Real flag name will be <code>"--{}".format(name)</code>.
<em>args, </em>*kwargs: The rest arguments are the same as
Expand All @@ -1063,6 +1065,9 @@ <h2 class="section-title" id="header-functions">Functions</h2>
<pre><code>def add_flag(name, *args, **kwargs):
"""Add a flag.

Added flags can be accessed by `FLAGS` global variable.
(e.g. `FLAGS.my_flag_name`)

Args:
name: Flag name. Real flag name will be `"--{}".format(name)`.
*args, **kwargs: The rest arguments are the same as
Expand Down

0 comments on commit f86abc0

Please sign in to comment.