Skip to content

Commit

Permalink
Merge pull request #394 from anqxyr/Issue-#371
Browse files Browse the repository at this point in the history
Fix for issue #371
  • Loading branch information
bboe committed Apr 12, 2015
2 parents 1652cc5 + 3343b47 commit 3275962
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions praw/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,12 @@ def wrapped(self, *args, **kwargs):
else:
return function(self.reddit_session, self, *args, **kwargs)
# Only grab the short-line doc and add a link to the complete doc
wrapped.__doc__ = wrapped.__doc__.split('\n', 1)[0]
wrapped.__doc__ += ('\n\nSee :meth:`.{0}.{1}` for complete usage. '
'Note that you should exclude the subreddit parameter '
'when calling this convenience method.'
.format(class_name, function.__name__))
if wrapped.__doc__ is not None:
wrapped.__doc__ = wrapped.__doc__.split('\n', 1)[0]
wrapped.__doc__ += ('\n\nSee :meth:`.{0}.{1}` for complete usage. '
'Note that you should exclude the subreddit '
'parameter when calling this convenience method.'
.format(class_name, function.__name__))
# Don't hide from sphinx as this is a parameter modifying decorator
return wrapped

Expand Down

0 comments on commit 3275962

Please sign in to comment.