Opened 15 years ago

Closed 15 years ago

Last modified 13 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: dev
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

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 15 years ago.

Download all attachments as: .zip

Change History (13)

comment:1 by Gary Wilson, 15 years ago

(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 by Gary Wilson, 15 years ago

(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 by Jacob, 15 years ago

milestone: → 1.1
Triage Stage: Unreviewed → Accepted

comment:4 by Jacob, 15 years ago

Owner: changed from nobody to Jacob
Status: new → assigned

comment:5 by Idan Gazit, 15 years ago

Owner: changed from Jacob to Idan Gazit
Status: assigned → new

Taking this one for the plane.

by Idan Gazit, 15 years ago

Attachment: 10272-document-signatures-parameters-r10680.diff​ added

comment:6 by Idan Gazit, 15 years ago

Has patch: set
Status: new → assigned
Version: 1.0 → SVN

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 by Idan Gazit, 15 years ago

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 by Idan Gazit, 15 years ago

Triage Stage: Accepted → Ready for checkin

comment:9 by Jacob, 15 years ago

Owner: changed from Idan Gazit to Jacob

comment:10 by Jacob, 15 years ago

Resolution: → fixed
Status: assigned → closed

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

comment:11 by Jacob, 15 years ago

(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 by Jacob, 13 years ago

milestone: 1.1

Milestone 1.1 deleted

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