Code

Opened 3 years ago

Closed 2 years ago

Last modified 2 years ago

#16980 closed Cleanup/optimization (fixed)

updates and fixes to auth docs

Reported by: ptone 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 ptone 3 years ago.

Download all attachments as: .zip

Change History (5)

Changed 3 years ago by ptone

comment:1 Changed 3 years ago by julien

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement set
  • Triage Stage changed from Unreviewed to Accepted

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 3 years ago by ptone

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 2 years ago by Tim Graham <timograham@…>

  • Resolution set to fixed
  • Status changed from new to closed

In [865ff32b84316a416661abc3e3e15c753395486c]:

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

comment:4 Changed 2 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

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.