Skip to content

Update common-schema-collections.md #10150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

FesterCluck
Copy link

See https://learn.microsoft.com/en-us/dotnet/framework/data/adonet/common-schema-collections?source=docs

See the section for ParameterMarkerPattern

MathJax is attempting to parse the two $ as inline math mode and removing parts of the docs on this page. Escaping the dollar sign fixes this since MathJax.tex.processEscapes is true.

However, this assumes that the entries here target learn.microsoft.com primarily. Adding those backslashes carries an awkward context when these docs are viewed on their own. If this assumption is not true, please point me towards any preprocessor that might be used for learn.microsoft.com and I'll offer a more comprehensive fix.

See https://learn.microsoft.com/en-us/dotnet/framework/data/adonet/common-schema-collections?source=docs

See the section for ParameterMarkerPattern

MathJax is attempting to parse the two $ as inline math mode and removing parts of the docs on this page. Escaping the dollar sign fixes this since MathJax.tex.processEscapes is true..

However, this assumes that the entries here target learn.microsoft.com primarily. Adding those backslashes carries an awkward context when these docs are viewed on their own. If this assumption is not true, please point me towards any preprocessor that might be used for learn.microsoft.com and I'll offer a more comprehensive fix.
Copy link
Contributor

@FesterCluck : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit 1bf1251:

✅ Validation status: passed

File Status Preview URL Details
docs/connect/ado-net/common-schema-collections.md ✅Succeeded

For more details, please refer to the build report.

@v-dirichards
Copy link
Contributor

@David-Engel

Can you review the proposed changes?

Important: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator bot added the aq-pr-triaged tracking label for the PR review team label Aug 4, 2025
@David-Engel
Copy link
Contributor

@FesterCluck This isn't the right place to fix the issue you pointed to. This is the source for the forked Microsoft.Data.SqlClient (MDS) library docs: https://learn.microsoft.com/en-us/sql/connect/ado-net/common-schema-collections?view=sql-server-ver16.

The source for the System.Data.SqlClient (SDS) page you linked to in your description is here: https://github.com/dotnet/docs/blob/main/docs/framework/data/adonet/common-schema-collections.md?plain=1#L40

Apparently the learn page for SDS is using MathJax but the one for MDS isn't. I don't know who controls the JavaScript packages used nor do I know if this fix is appropriate or if a tweak to MathJax should be or can be made to ignore text within backticks. You can note the possible option in your proposed change there. The owners over at https://github.com/dotnet/docs should know.

#please-close

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants