Code

Opened 7 years ago

Closed 7 years ago

#3483 closed (fixed)

Document AUTH_PROFILE_MODULE

Reported by: Marc Fargas <telenieko@…> Owned by: nobody
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

The AUTH_PROFILE_MODULE isn't documented, the whole "Profile" support is undocumented except for a small reference to the 'get_profile' method in [source:django/trunk/docs/authentication.txt authentication docs] maybe it should be documented somewhere, the best source of information I could find about it is this b-list post, there is also this wiki page which should be updated to reflect this new setting maybe with a note to the documentation if it gets added.

On the code you can get a few more information: [source:django/trunk/django/contrib/auth/models.py here]

Attachments (2)

authentication.profile.diff (3.9 KB) - added by adrian@… 7 years ago.
Patch adding "Extendig the profile system" to the documentation
authentication.profile-v2.diff (3.9 KB) - added by adrian@… 7 years ago.
added "login required" to the view, and other small changes

Download all attachments as: .zip

Change History (13)

comment:1 Changed 7 years ago by ubernostrum

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

The Django book documents it: http://www.djangobook.com/en/beta/chapter12/#cn226

That can probably be rolled in to the official docs, per plans to do that with most of the stuff in the book.

comment:2 Changed 7 years ago by Simon G. <dev@…>

  • Triage Stage changed from Unreviewed to Accepted

comment:3 Changed 7 years ago by anonymous

This is still undocumented.

comment:4 Changed 7 years ago by aribao@…

Why is still undocumented? Are you planning to change it? I'm gonna start a big project and I need this feature, but please tell me if you plan to change this.
Is the setting AUTH_PROFILE_MODULE the right way to get it working?

comment:5 Changed 7 years ago by Simon G. <dev@…>

Why haven't we done it? Lack of time. Feel free to help out. If it's in the book it's not likely to change.

comment:6 follow-up: Changed 7 years ago by adrian@…

I'll start to work on it today or on Friday. I hope I can submit the patch before next week.

comment:7 in reply to: ↑ 6 Changed 7 years ago by adrian@…

Replying to adrian@adrima.es:

I'll start to work on it today or on Friday. I hope I can submit the patch before next week.

By the way, I'm the same user as aribao@…, I just wrote other email.
adrian@… = aribao@… :-)

comment:8 Changed 7 years ago by Simon G. <dev@…>

that would be most appreciated!

Changed 7 years ago by adrian@…

Patch adding "Extendig the profile system" to the documentation

comment:9 Changed 7 years ago by adrian@…

  • Has patch set

I have documented the extendable profile system. Most of the text comes from the djangobook because I'm Spanish and I thought it would be better to copy it rather than write it by myself.

Important: The patch MUST be reviewed by some native English speaker before applying it.

I hope it's ok.

Changed 7 years ago by adrian@…

added "login required" to the view, and other small changes

comment:10 Changed 7 years ago by Simon G. <dev@…>

Thank you! Jacob's just checking out the legalities of what can/can't be merged in from the Djangobook (we want to be very careful here for obvious reasons), but once that's sorted out we'll deal with it :)

comment:11 Changed 7 years ago by ubernostrum

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

(In [6810]) Fixed #3483: Documented AUTH_PROFILE_MODULE and custom user profiles

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.