Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pydoc for Optimizer setup syntax sugar #4167

Merged
merged 2 commits into from
Feb 7, 2018

Conversation

kmaehashi
Copy link
Member

Update pydoc for change introduced in #4141 (optimizer setup syntax sugar)

@kmaehashi kmaehashi added this to the v4.0.0b3 milestone Jan 9, 2018
@kmaehashi kmaehashi added the cat:document Documentation such as function documentations, comments and tutorials. label Jan 9, 2018
@kmaehashi kmaehashi changed the title update pydocs for #4141 Update pydoc for Optimizer setup syntax sugar Jan 9, 2018
@toslunar
Copy link
Member

toslunar commented Jan 9, 2018

Thanks!

.. note::
As of v4.0.0, this function returns the optimizer instance itself
so that you can instantiate and setup the optimizer in one line,
e.g., ``optimizer = SomeOptimizer().setup(model)``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.setup(link) or .setup(link=model) would be more informative to me.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, fixed as suggested.

@kmaehashi kmaehashi removed this from the v4.0.0b3 milestone Jan 22, 2018
@Crissman Crissman merged commit e93809c into chainer:master Feb 7, 2018
@kmaehashi kmaehashi deleted the fix-pydoc branch February 7, 2018 06:48
@kmaehashi kmaehashi added this to the v4.0.0b4 milestone Feb 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat:document Documentation such as function documentations, comments and tutorials.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants