diff options
| author | Ramil Yanbulatov <rayman1104@gmail.com> | 2022-08-09 14:50:05 +0200 |
|---|---|---|
| committer | Carlton Gibson <carlton.gibson@noumenal.es> | 2022-08-09 14:51:59 +0200 |
| commit | cccfb45d0044513f2c632d2a5d5544127d0d019b (patch) | |
| tree | 3ebb1af3fee815da46c9ec647a252eac56feb48c | |
| parent | d69959446221981f87226249e56d8cc0956a3950 (diff) | |
Refs #33842 -- Removed incorrect :file: role in contrib docs.
The file role is not appropriate for URLs and URL path-components.
| -rw-r--r-- | docs/ref/contrib/sitemaps.txt | 6 | ||||
| -rw-r--r-- | docs/ref/contrib/syndication.txt | 6 |
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/ref/contrib/sitemaps.txt b/docs/ref/contrib/sitemaps.txt index c985ddb81a..d3225405a3 100644 --- a/docs/ref/contrib/sitemaps.txt +++ b/docs/ref/contrib/sitemaps.txt @@ -156,9 +156,9 @@ Note: In both cases, "absolute path" means a URL that doesn't include the protocol or domain. Examples: - * Good: :file:`'/foo/bar/'` - * Bad: :file:`'example.com/foo/bar/'` - * Bad: :file:`'https://example.com/foo/bar/'` + * Good: ``'/foo/bar/'`` + * Bad: ``'example.com/foo/bar/'`` + * Bad: ``'https://example.com/foo/bar/'`` If :attr:`~Sitemap.location` isn't provided, the framework will call the ``get_absolute_url()`` method on each object as returned by diff --git a/docs/ref/contrib/syndication.txt b/docs/ref/contrib/syndication.txt index 1b255c6b40..9a65d7bbc2 100644 --- a/docs/ref/contrib/syndication.txt +++ b/docs/ref/contrib/syndication.txt @@ -210,8 +210,8 @@ items based on information in the feed's URL. The police beat feeds could be accessible via URLs like this: -* :file:`/beats/613/rss/` -- Returns recent crimes for beat 613. -* :file:`/beats/1424/rss/` -- Returns recent crimes for beat 1424. +* ``/beats/613/rss/`` -- Returns recent crimes for beat 613. +* ``/beats/1424/rss/`` -- Returns recent crimes for beat 1424. These can be matched with a :doc:`URLconf </topics/http/urls>` line such as:: @@ -314,7 +314,7 @@ URLs ---- The ``link`` method/attribute can return either an absolute path (e.g. -:file:`"/blog/"`) or a URL with the fully-qualified domain and protocol (e.g. +``"/blog/"``) or a URL with the fully-qualified domain and protocol (e.g. ``"https://www.example.com/blog/"``). If ``link`` doesn't return the domain, the syndication framework will insert the domain of the current site, according to your :setting:`SITE_ID setting <SITE_ID>`. |