#33210: Sitemap framework URL examples lack `name` parameter (used by
ping_google
helper)
-------------------------------------+-------------------------------------
Reporter: Carlton | Owner: Arkadiusz Adamski
Gibson |
Type: | Status: assigned
Cleanup/optimization |
Component: | Version: 3.2
contrib.sitemaps |
Severity: Normal | Keywords: Documentation
Triage Stage: Accepted | Has patch: 1
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 1 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
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 [https://docs.djangoproject.com/en/3.2/ref/contrib/sitemaps
/#pinging-google 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.
[https://github.com/django/django/pull/14994 Pull Request]
--
Ticket URL: <https://code.djangoproject.com/ticket/33210>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/056.61e67624ca911a599a137ecbcea9f310%40djangoproject.com.
