From 1688b53f421014c713564ba1d2bd5a9d4e2874b2 Mon Sep 17 00:00:00 2001 From: Anthony Johnson Date: Tue, 27 Oct 2015 01:12:25 -0700 Subject: [PATCH] Replace non-existant :dn:ref: reference with :any: for now This will resolve more lookups as proper references, not anchor links. The :any: lookup is strict though, the domain should implement it's own :dn:obj: generic lookup. --- autoapi/mappers/dotnet.py | 18 +++++++++--------- tests/test_domains.py | 4 ++-- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/autoapi/mappers/dotnet.py b/autoapi/mappers/dotnet.py index bec433a..9d06fca 100644 --- a/autoapi/mappers/dotnet.py +++ b/autoapi/mappers/dotnet.py @@ -35,12 +35,12 @@ DOC_COMMENT_PARAM_PATTERN = re.compile( # Comment member identities # From: https://msdn.microsoft.com/en-us/library/vstudio/fsbx0t7x(v=VS.100).aspx DOC_COMMENT_IDENTITIES = { - 'N': 'ns', - 'T': 'ref', # can be any type (class, delegate, enum, etc), so use ref - 'F': 'field', - 'P': 'prop', - 'M': 'meth', - 'E': 'event', + 'N': 'dn:ns', + 'T': 'any', # can be any type (class, delegate, enum, etc), so use any + 'F': 'dn:field', + 'P': 'dn:prop', + 'M': 'dn:meth', + 'E': 'dn:event', } @@ -378,19 +378,19 @@ class DotNetPythonMapper(PythonMapperBase): .replace('<', '\<') .replace('`', '\`')) - reftype = 'ref' + reftype = 'any' replacement = '' # Given the pattern of `\w:\w+`, inspect first letter of # reference for identity type if ref[1] == ':' and ref[0] in DOC_COMMENT_IDENTITIES: reftype = DOC_COMMENT_IDENTITIES[ref[:1]] ref = ref[2:] - replacement = ':dn:{reftype}:`{ref}`'.format( + replacement = ':{reftype}:`{ref}`'.format( reftype=reftype, ref=ref) elif ref[:2] == '!:': replacement = ref[2:] else: - replacement = ':dn:ref:`{ref}`'.format(ref=ref) + replacement = ':any:`{ref}`'.format(ref=ref) # Escape following text text_end = text[found.end():] diff --git a/tests/test_domains.py b/tests/test_domains.py index 9d024a5..5111941 100644 --- a/tests/test_domains.py +++ b/tests/test_domains.py @@ -95,7 +95,7 @@ class DomainTests(unittest.TestCase): '''XML doc comment parsing''' ret = dotnet.DotNetPythonMapper.transform_doc_comments( 'This is an example comment ') - self.assertEqual(ret, 'This is an example comment :dn:ref:`FOO`') + self.assertEqual(ret, 'This is an example comment :any:`FOO`') ret = dotnet.DotNetPythonMapper.transform_doc_comments( 'This is an example comment ') @@ -121,7 +121,7 @@ class DomainTests(unittest.TestCase): """XML transform escaping""" ret = dotnet.DotNetPythonMapper.transform_doc_comments( 'Foo Bar') - self.assertEqual(ret, 'Foo :dn:ref:`Foo\\`1` Bar') + self.assertEqual(ret, 'Foo :any:`Foo\\`1` Bar') ret = dotnet.DotNetPythonMapper.transform_doc_comments( 'No space beforeor after')