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

Ticket #20687 -- Added documentation for django.core.signing API. #1323

Closed
wants to merge 2 commits into from
Closed

Ticket #20687 -- Added documentation for django.core.signing API. #1323

wants to merge 2 commits into from

Conversation

tricoder42
Copy link
Contributor

@@ -183,6 +183,11 @@ def sign(self, value):
return super(TimestampSigner, self).sign(value)

def unsign(self, value, max_age=None):
"""
Retrieve original value and check it wasn't signed longer than
Copy link
Member

Choose a reason for hiding this comment

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

rephrase: signed more than max_age seconds ago (also remove extra newline in docstring)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Extra newline is suggested in PEP 8 http://www.python.org/dev/peps/pep-0008/#documentation-strings
However, I'll try to rephrase it and maybe it fits to oneline.

Copy link
Member

Choose a reason for hiding this comment

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

I'd prefer to keep the docstring consistent with those in the rest of the file (which don't have the extra line).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, I've deleted it. I didn't check the rest of the file before.

@timgraham
Copy link
Member

merged in c5bc98d, thanks!

@timgraham timgraham closed this Jul 3, 2013
@tricoder42 tricoder42 deleted the ticket-20687 branch July 3, 2013 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants