Context Navigation

← Previous Ticket
Next Ticket →

#24244 closed New feature (fixed)

Document contrib.admin.models.LogEntry

Reported by:	Tim Graham	Owned by:	Alex Morozov
Component:	Documentation	Version:	dev
Severity:	Normal	Keywords:	afraid-to-commit
Cc:		Triage Stage:	Accepted
Has patch:	yes	Needs documentation:	no
Needs tests:	no	Patch needs improvement:	no
Easy pickings:	yes	UI/UX:	no

Description (last modified by Paul Hallett)

It would be useful to document the fields and methods of this model.

A test also needs to be added for the get_edited_object() method as it's currently not covered.

Attachments (1)

ticket_24244.diff (1.0 KB ) - added by Varun Sharma 10 years ago.

Download all attachments as: .zip

Change History (24)

comment:1 by Paul Hallett, 10 years ago

Description:	modified (diff)

comment:2 by Varun Sharma, 10 years ago

Owner:	changed from nobody to Varun Sharma
Status:	new → assigned

comment:3 by Daniele Procida, 10 years ago

Keywords:	afraid-to-commit added

by Varun Sharma, 10 years ago

Attachment:	ticket_24244.diff added

comment:4 by Varun Sharma, 10 years ago

Has patch:	set

PR: https://github.com/django/django/pull/4363

comment:5 by Paul Hallett, 10 years ago

PR has a test case but no documentation, do we want to separate these into separate tickets?

comment:6 by Tim Graham <timograham@…>, 10 years ago

In 74f8110e:

Added test for LogEntry.get_edited_object(); refs #24244.

comment:7 by Tim Graham <timograham@…>, 10 years ago

In 8f5e8ab6:

[1.8.x] Added test for LogEntry.get_edited_object(); refs #24244.

Backport of 74f8110e74927c231bfcd106fa28bf6e6dd034e6 from master

comment:8 by Tim Graham, 10 years ago

Has patch:	unset

I committed the test, we can keep this ticket open for the documentation.

comment:9 by Tim Graham, 10 years ago

Owner:	Varun Sharma removed
Status:	assigned → new

comment:10 by Varun Sharma, 10 years ago

Where to add documentation ?
Can't find any admin related docs directory in docs/internals

comment:11 by Tim Graham, 10 years ago

Docs for contrib.admin are in docs/ref/contrib/admin.

comment:12 by sholleman, 10 years ago

Owner:	set to sholleman
Status:	new → assigned

comment:13 by maestrofjp, 10 years ago

Owner:	changed from sholleman to maestrofjp

I have documentation in the works.

comment:14 by sholleman, 10 years ago

Owner:	changed from maestrofjp to sholleman

Assigning back to me per maestrofjp.

comment:15 by maestrofjp, 10 years ago

Apologies for stealing the ticket. I should have refreshed the page after letting it sit for ages. Let we were able to sit down to see that we were both on the same page on how to do it.

comment:16 by Alex Morozov, 9 years ago

@sholleman, won't you mind if I'll take this ticket?

comment:17 by Claude Paroz, 9 years ago

Owner:	sholleman removed
Status:	assigned → new

When no progress has been made after several months, feel free to take any ticket!

comment:18 by Varun Sharma, 9 years ago

Owner:	set to Varun Sharma
Status:	new → assigned

Patch almost ready. Creating PR by tomorrow.

comment:19 by Alex Morozov, 9 years ago

Owner:	changed from Varun Sharma to Alex Morozov

The pull request is at https://github.com/django/django/pull/5533 . Should I specify it somewhere else?

comment:20 by Alex Morozov, 9 years ago

Has patch:	set

comment:21 by Tim Graham <timograham@…>, 9 years ago

Resolution:	→ fixed
Status:	assigned → closed

In 99c58c27:

Fixed #24244 -- Documented contrib.admin.models.LogEntry

comment:22 by Tim Graham <timograham@…>, 9 years ago

In a31973c7:

[1.8.x] Fixed #24244 -- Documented contrib.admin.models.LogEntry

Backport of 99c58c27d5a8e4a66230c413380508af223d12a8 from master

comment:23 by Tim Graham <timograham@…>, 9 years ago

In 4940465:

[1.9.x] Fixed #24244 -- Documented contrib.admin.models.LogEntry