Opened 8 years ago

Closed 8 years ago

Last modified 5 years ago

#10272 closed (fixed)

document signatures and optional parameters for the contrib.auth views

Reported by: Gary Wilson Owned by: Jacob
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

The auth views are listed in the "Other built-in views" section of the topics/auth.txt documentation, but many are lacking signatures and documentation of all their optional parameters.

Attachments (1)

10272-document-signatures-parameters-r10680.diff (6.7 KB) - added by Idan Gazit 8 years ago.

Download all attachments as: .zip

Change History (13)

comment:1 Changed 8 years ago by Gary Wilson

(In [9835]) Auth-related doc cleanups:

  • Added to documentation of missing characters from allowed_chars in make_random_password.
  • Fixed several long lines and word wraps.
  • Added a reference link to the "How to log a user in" section and made a later reference to this section an actual link using the :ref: directive.
  • Turned a command line code example into a code block.
  • Added attribute reference link for a request.META mention.
  • Added code-block:: html directives for HTML examples.
  • Corrected reference links for all the auth.views functions.
  • Added a few function signatures and documentation of optional parameters that were missing for some of the the auth.views functions (refs #10272).

comment:2 Changed 8 years ago by Gary Wilson

(In [9836]) [1.0.X] Auth-related doc cleanups:

  • Added to documentation of missing characters from allowed_chars in make_random_password.
  • Fixed several long lines and word wraps.
  • Added a reference link to the "How to log a user in" section and made a later reference to this section an actual link using the :ref: directive.
  • Turned a command line code example into a code block.
  • Added attribute reference link for a request.META mention.
  • Added code-block:: html directives for HTML examples.
  • Corrected reference links for all the auth.views functions.
  • Added a few function signatures and documentation of optional parameters that were missing for some of the the auth.views functions (refs #10272).

Backport of r9835 from trunk.

comment:3 Changed 8 years ago by Jacob

milestone: 1.1
Triage Stage: UnreviewedAccepted

comment:4 Changed 8 years ago by Jacob

Owner: changed from nobody to Jacob
Status: newassigned

comment:5 Changed 8 years ago by Idan Gazit

Owner: changed from Jacob to Idan Gazit
Status: assignednew

Taking this one for the plane.

Changed 8 years ago by Idan Gazit

comment:6 Changed 8 years ago by Idan Gazit

Has patch: set
Status: newassigned
Version: 1.0SVN

Went through all of the views in login and made sure that they were

  1. in the docs
  2. had the (correct) signatures
  3. had descriptions for each of the arguments and context vars

Also fixed some minor grammar errors. See attached patch!

comment:7 Changed 8 years ago by Idan Gazit

Forgot to mention:

There's one parameter I didn't document because I wasn't sure that it would be useful outside of the admin context: is_admin_site in views.password_reset.

comment:8 Changed 8 years ago by Idan Gazit

Triage Stage: AcceptedReady for checkin

comment:9 Changed 8 years ago by Jacob

Owner: changed from Idan Gazit to Jacob

comment:10 Changed 8 years ago by Jacob

Resolution: fixed
Status: assignedclosed

(In [10770]) Fixed #10272: documented the signatures for the contrib.auth views. Thanks, Idan Gazit.

comment:11 Changed 8 years ago by Jacob

(In [10771]) [1.0.X] Fixed #10272: documented the signatures for the contrib.auth views. Thanks, Idan Gazit. Backport of [10770] from trunk.

comment:12 Changed 5 years ago by Jacob

milestone: 1.1

Milestone 1.1 deleted

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