Opened 5 years ago

Closed 4 years ago

Last modified 4 years ago

#16980 closed Cleanup/optimization (fixed)

updates and fixes to auth docs

Reported by: Preston Holmes Owned by: nobody
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no

Description

The attached patch cleans up auth docs with regard to some of the newer features and/or deprecated enforcement of API changes.

It also addresses #15600 and #13933

Attachments (1)

auth_docs_cleanup.diff (5.5 KB) - added by Preston Holmes 5 years ago.

Download all attachments as: .zip

Change History (5)

Changed 5 years ago by Preston Holmes

Attachment: auth_docs_cleanup.diff added

comment:1 Changed 5 years ago by Julien Phalip

Patch needs improvement: set
Triage Stage: UnreviewedAccepted

This looks excellent, thanks! I've just got a couple of minor remarks: The reference "inactive_auth" is probably not necessary since it doesn't seem to be used; and I think it'd be useful to add, as pointed by PaulM in #15600, something along the lines of "You may either implement your own rate limiting mechanism or use the mechanisms provided by most Web servers (such as NginX or Apache)".

comment:2 Changed 5 years ago by Preston Holmes

switching to pull request, this supersedes the attached diff:

https://github.com/django/django/pull/59

I added the note about rate limiting as suggested.

One potential cleanup would be to also combine the sections on handling anonymous and inactive users, though that could wait until 1.5 and the deprecation conclusion.

Also per this discussion http://groups.google.com/group/django-developers/browse_thread/thread/bad403fd55a0b1d6

I may add on a note about the current behavior of login_required to this cleanup

comment:3 Changed 4 years ago by Tim Graham <timograham@…>

Resolution: fixed
Status: newclosed

In [865ff32b84316a416661abc3e3e15c753395486c]:

Fixed #16980 - Misc updates to the auth docs. Thanks Preston Holmes for the patch.

comment:4 Changed 4 years ago by Tim Graham <timograham@…>

In [c54034a2ad9e0ebf918530fa4b8f11e4ea0f489e]:

[1.4.X] Fixed #16980 - Misc updates to the auth docs. Thanks Preston Holmes for the patch.

Backport of 865ff32b84 from master

Note: See TracTickets for help on using tickets.
Back to Top