Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#33210 closed Cleanup/optimization (fixed)

Sitemap framework URL examples lack `name` parameter (used by ping_google helper)

Reported by: Carlton Gibson Owned by: Arkadiusz Adamski
Component: contrib.sitemaps Version: 3.2
Severity: Normal Keywords: Documentation
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Migrated from https://github.com/django/djangoproject.com/issues/1103.

The ping_google() helper in the sitemaps framework looks for URLs named 'django.contrib.sitemaps.views.index' and then 'django.contrib.sitemaps.views.sitemap' to autodetect the sitemap URL, if one's not provided.

The combination of these two means that you need to look at the source code to know how to correctly leverage the auto-detection — adding to the docs would clarify this.

Pull Request

Change History (4)

comment:1 by Carlton Gibson, 3 years ago

Triage Stage: AcceptedReady for checkin

comment:2 by Carlton Gibson, 3 years ago

Patch needs improvement: unset

comment:3 by Carlton Gibson <carlton.gibson@…>, 3 years ago

Resolution: fixed
Status: assignedclosed

In 1405dc7:

Fixed #33210 -- Clarified docs for sitemaps ping_google() helper.

comment:4 by Mariusz Felisiak <felisiak.mariusz@…>, 3 years ago

In ac815f6:

[4.0.x] Fixed #33210 -- Clarified docs for sitemaps ping_google() helper.

Backport of 1405dc78872f9d18180feebb4f2c57dbe1259acb from main

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