Opened 5 years ago

Closed 4 years ago

Last modified 4 years ago

#24244 closed New feature (fixed)

Document contrib.admin.models.LogEntry

Reported by: Tim Graham Owned by: Alex Morozov
Component: Documentation Version: master
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 5 years ago.

Download all attachments as: .zip

Change History (24)

comment:1 Changed 5 years ago by Paul Hallett

Description: modified (diff)

comment:2 Changed 5 years ago by Varun Sharma

Owner: changed from nobody to Varun Sharma
Status: newassigned

comment:3 Changed 5 years ago by Daniele Procida

Keywords: afraid-to-commit added

Changed 5 years ago by Varun Sharma

Attachment: ticket_24244.diff added

comment:4 Changed 5 years ago by Varun Sharma

Has patch: set

comment:5 Changed 5 years ago by Paul Hallett

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

comment:6 Changed 5 years ago by Tim Graham <timograham@…>

In 74f8110e:

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

comment:7 Changed 5 years ago by Tim Graham <timograham@…>

In 8f5e8ab6:

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

Backport of 74f8110e74927c231bfcd106fa28bf6e6dd034e6 from master

comment:8 Changed 5 years ago by Tim Graham

Has patch: unset

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

comment:9 Changed 5 years ago by Tim Graham

Owner: Varun Sharma deleted
Status: assignednew

comment:10 Changed 5 years ago by Varun Sharma

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

comment:11 Changed 5 years ago by Tim Graham

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

comment:12 Changed 5 years ago by sholleman

Owner: set to sholleman
Status: newassigned

comment:13 Changed 5 years ago by maestrofjp

Owner: changed from sholleman to maestrofjp

I have documentation in the works.

comment:14 Changed 5 years ago by sholleman

Owner: changed from maestrofjp to sholleman

Assigning back to me per maestrofjp.

comment:15 Changed 5 years ago by maestrofjp

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 Changed 4 years ago by Alex Morozov

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

comment:17 Changed 4 years ago by Claude Paroz

Owner: sholleman deleted
Status: assignednew

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

comment:18 Changed 4 years ago by Varun Sharma

Owner: set to Varun Sharma
Status: newassigned

Patch almost ready. Creating PR by tomorrow.

comment:19 Changed 4 years ago by Alex Morozov

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 Changed 4 years ago by Alex Morozov

Has patch: set

comment:21 Changed 4 years ago by Tim Graham <timograham@…>

Resolution: fixed
Status: assignedclosed

In 99c58c27:

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

comment:22 Changed 4 years ago by Tim Graham <timograham@…>

In a31973c7:

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

Backport of 99c58c27d5a8e4a66230c413380508af223d12a8 from master

comment:23 Changed 4 years ago by Tim Graham <timograham@…>

In 4940465:

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

Backport of 99c58c27d5a8e4a66230c413380508af223d12a8 from master

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