'description' key in InlineModelAdmin fieldsets is ignored

[Greg]

The ​InlineModelAdmin supports fieldsets, just like ModelAdmin objects. However, if you add a 'description' key, it does not appear on the rendered form.

For example:

class BookInline(admin.TabularInline):
    model = Book
    fieldsets = (
        (None, {
            'description': 'These are the related books.',
            'fields': ('name', 'date'),
        }),
    )

I would expect to see 'These are the related books.' in the tabular inline section for Books, but I don't.

(I suspect other fieldset keys are ignored in inlines, too. I haven't tried those.)

I am will share a branch with a fix for this on GitHub soon.

[Greg]

Here is a link to a branch with a fix in my repo: ​https://github.com/nofeet/django/tree/ticket_21353

It looks for and uses the description for only the first fieldset in the inline admin form. I'm not exactly sure how the inline fieldsets and forms work, so this is the cleanest fix I came across after several attempts. Perhaps someone with more knowledge can come up with a better solution.

[Tim Graham]

This should be fixed on stacked.html as well. It also needs tests in order to be merged.

[chexov34@…]

Hello nofinator.
Can I help you for create tests ? :)
My mail: chexov34@…

[Greg]

Thanks, chexov34, but since this is my first dev work for the Django code base, I'd like to give it a try. I saw that there are already some test InlineAdmin models with fieldsets already, so I hope to write the tests within the next few days.

[Greg]

Replying to timo:

This should be fixed on stacked.html as well.

I tried out StackedInlines and they work already for fieldsets because stacked.html includes fieldset.html.

It also needs tests in order to be merged.

Ah, of course. I just pushed a test for this on ​my branch.

[Greg]

I also created a pull request if you think it's ready: ​https://github.com/django/django/pull/1882

[Greg]

I think I set the resolution to fixed prematurely.

[Tim Graham]

As I noticed on the pull request, fieldset.name isn't rendered either, maybe this was intentionally omitted in the tabular inline. Just stacking up the descriptions where they don't really correspond to the fields doesn't seem very elegant. It may be best just to document that description doesn't apply when using TabularInlines.

[Tim Graham <timograham@…>]

In d5031ecf881eaefe7ada1c35228b35a1852dd343:

Fixed #21353 -- Noted that description is ignored for TabularInlines.

Thanks nofinator for the report.

[Tim Graham <timograham@…>]

In ae78227de3740cce7e2b460b2845f19443c4d090:

[1.7.x] Fixed #21353 -- Noted that description is ignored for TabularInlines.

Thanks nofinator for the report.

Backport of d5031ecf88 from master

[Tim Graham <timograham@…>]

In de95867284ddf84bb4ca5e5946bae96d5d23babf:

[1.6.x] Fixed #21353 -- Noted that description is ignored for TabularInlines.

Thanks nofinator for the report.

Backport of d5031ecf88 from master