Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Sql Client XML Help file has bad HTML that breaks Sandcastle

See original GitHub issue

The System.Data.SqlClient.xml file has bad XML reported in Sandcastle as:

Reason: The ‘p’ start tag on line 506 position 2 does not match the end tag of ‘th’. Line 506, position 96.

This relates to the following:

<table><thead><tr><th> Value  <p>
<p sourcefile="System.Data.SqlClient.yml" sourcestartlinenumber="4" sourceendlinenumber="4"> </th><th> Description  <p>
<p sourcefile="System.Data.SqlClient.yml" sourcestartlinenumber="6" sourceendlinenumber="6"> </th></tr></thead><tbody><tr><td> SQL Server 2005  <p>
<p sourcefile="System.Data.SqlClient.yml" sourcestartlinenumber="8" sourceendlinenumber="8"> </td><td> Uses the SQL Server 2005 type system. No conversions are made for the current version of ADO.NET.  <p>
<p sourcefile="System.Data.SqlClient.yml" sourcestartlinenumber="10" sourceendlinenumber="10"> </td></tr><tr><td> SQL Server 2008  <p>
<p sourcefile="System.Data.SqlClient.yml" sourcestartlinenumber="12" sourceendlinenumber="12"> </td><td> Uses the SQL Server 2008 type system.  <p>
<p sourcefile="System.Data.SqlClient.yml" sourcestartlinenumber="14" sourceendlinenumber="14"> </td></tr><tr><td> Latest  <p>
<p sourcefile="System.Data.SqlClient.yml" sourcestartlinenumber="16" sourceendlinenumber="16"> </td><td> Use the latest version than this client-server pair can handle. This will automatically move forward as the client and server components are upgraded.  <p>
<p sourcefile="System.Data.SqlClient.yml" sourcestartlinenumber="18" sourceendlinenumber="18"> </td></tr></tbody></table>

where you can see the lack of closures of the P tags etc.

Issue Analytics

State:
Created 4 years ago
Comments:7 (4 by maintainers)

Top GitHub Comments

1reaction

MCFHTAGENTScommented, Feb 28, 2020

Thanks all

I have raised an issue here https://github.com/EWSoftware/SHFB/issues/787 - yes I was talking about that project.

I had moved my code over to the Microsoft.Data.SqlClient namespace but the old System one must be being referenced by one of my components as it appears in reflection and yes it is that one that appears in the logs! I will try and find out how this file is being created (verbose logging isn’t telling me! - Sandcastle caches some of these but not, on the face of it, this one) and report back.

Thanks Mark

0reactions

cheenamalhotracommented, Mar 4, 2020

Hi @MCFHTAGENTS

I’ll close the issue at our end, as the issue does not persist in newer driver versions that we maintain.