#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 docs examples don't show this.
- the Pinging Google docs don't explain how the auto-detection works.
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.
Change History (4)
comment:1 by , 4 years ago
| Triage Stage: | Accepted → Ready for checkin |
|---|
comment:2 by , 4 years ago
| Patch needs improvement: | unset |
|---|
comment:3 by , 4 years ago
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |
Note:
See TracTickets
for help on using tickets.
In 1405dc7: