From abdc953db15d3204f36c17233a1bab5fe58f7eea Mon Sep 17 00:00:00 2001 From: Antony Lee Date: Tue, 13 Aug 2019 15:48:50 +0200 Subject: [PATCH] Clarify special handling for colons in paths. --- doc/sphinxext/missing_references.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/sphinxext/missing_references.py b/doc/sphinxext/missing_references.py index 41e92653e97b..86fea1b2d3a2 100644 --- a/doc/sphinxext/missing_references.py +++ b/doc/sphinxext/missing_references.py @@ -94,12 +94,12 @@ def get_location(node, app): cannot locate the original source file (usually because an extension has injected text into the sphinx parsing engine). """ - (path, line) = get_source_line(node) + source, line = get_source_line(node) - if path: - # sometimes the 'path' can contain ':' which are forbidden on - # windows, but on posix just passes through. - path, *post = path.partition(':') + if source: + # 'source' can have the form '/some/path:docstring of some.api' but the + # colons are forbidden on windows, but on posix just passes through. + path, *post = source.partition(':') post = ''.join(post) # We locate references relative to the parent of the doc # directory, which for matplotlib, will be the root of the pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy