Opened 6 years ago

Closed 6 years ago

Last modified 4 years ago

#10272 closed (fixed)

document signatures and optional parameters for the contrib.auth views

Reported by: gwilson 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 idangazit 6 years ago.

Download all attachments as: .zip

Change History (13)

comment:1 Changed 6 years ago by gwilson

(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 6 years ago by gwilson

(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 6 years ago by jacob

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

comment:4 Changed 6 years ago by jacob

  • Owner changed from nobody to jacob
  • Status changed from new to assigned

comment:5 Changed 6 years ago by idangazit

  • Owner changed from jacob to idangazit
  • Status changed from assigned to new

Taking this one for the plane.

comment:6 Changed 6 years ago by idangazit

  • Has patch set
  • Status changed from new to assigned
  • Version changed from 1.0 to 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 Changed 6 years ago by idangazit

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 6 years ago by idangazit

  • Triage Stage changed from Accepted to Ready for checkin

comment:9 Changed 6 years ago by jacob

  • Owner changed from idangazit to jacob

comment:10 Changed 6 years ago by jacob

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

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

comment:11 Changed 6 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 4 years ago by jacob

  • milestone 1.1 deleted

Milestone 1.1 deleted

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