search

readthedocs / sphinxcontrib-dotnetdomain

A Sphinx domain for .NET languages
MIT License
15 stars 17 forks source link

Issues with spacing and XML tags in doc comments #42

Closed danroth27 closed 8 years ago

danroth27 commented 8 years ago

When I use autoapi on the master branch of the ASP.NET Identity repo, I get a bunch of warnings related to generic types and back ticks:

Microsoft\AspNet\Identity\EntityFramework\UserStore-TUser-TRole-TContext-TKey\index.rst:708: WARNING: Inline literal start-string without end-string.
Microsoft\AspNet\Identity\EntityFramework\UserStore-TUser-TRole-TContext-TKey\index.rst:708: WARNING: Inline literal start-string without end-string.
Microsoft\AspNet\Identity\EntityFramework\UserStore-TUser-TRole-TContext-TKey\index.rst:1359: WARNING: Inline literal start-string without end-string.
Microsoft\AspNet\Identity\EntityFramework\UserStore-TUser-TRole-TContext-TKey\index.rst:1359: WARNING: Inline literal start-string without end-string.
Microsoft\AspNet\Identity\IUserTwoFactorStore-TUser\index.rst:62: WARNING: Inline literal start-string without end-string.
Microsoft\AspNet\Identity\IUserTwoFactorStore-TUser\index.rst:62: WARNING: Inline literal start-string without end-string.
Microsoft\AspNet\Identity\IUserTwoFactorStore-TUser\index.rst:89: WARNING: Inline literal start-string without end-string.
Microsoft\AspNet\Identity\IUserTwoFactorStore-TUser\index.rst:89: WARNING: Inline literal start-string without end-string.
danroth27 commented 8 years ago

These warnings are caused by formatting issues in the doc comments: https://github.com/aspnet/Identity/pull/735 https://github.com/aspnet/Identity/pull/734