Opened 5 months ago

Closed 5 months ago

#35076 closed Cleanup/optimization (invalid)

improvement to the doc of ModelAdmin.view_on_site

Reported by: redstoneleo Owned by: nobody
Component: Documentation Version: 4.2
Severity: Normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Mariusz Felisiak)

Whether get_absolute_url() is defined determines the visible state of the “View on site” button, I suggest to change the doc to the following to emphasize this(Note I have read the official doc on contributing to the doc, but it is hard for me to do that, so I posted my suggestion here ).

If the object’s "django.db.models.Model.get_absolute_url" get_absolute_url() method is defined, then set view_on_site to control whether or not to display the “View on site” link. This link should bring you to a URL where you can display the saved object. Otherwise, no effect.

This value can be either a boolean flag or a callable. If True (the default), the object’s get_absolute_url()("django.db.models.Model.get_absolute_url") method will be used to generate the url.

Change History (1)

comment:1 by Mariusz Felisiak, 5 months ago

Description: modified (diff)
Resolution: invalid
Status: newclosed

Thanks for the ticket, however, the current wording is clear enough (IMO).

If True (the default), the object’s get_absolute_url() method will be used to generate the url.

It clearly indicates that it won't do anything if you model doesn't have a get_absolute_url(). It's also followed by a sentence when it's explicitly stated:

If your model has a get_absolute_url() method but you don’t want the “View on site” button to appear, you only need to set view_on_site to False:

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