Sql-docs: Attempt at formatting bleeds through into rendered document

Created on 1 Sep 2019  Â·  5Comments  Â·  Source: MicrosoftDocs/sql-docs

There are a number of places where there has been an attempt to use markdown formatting to display identifiers and variable names in a particular way. However, the rendered document shows things like

> _@variable\_name_

instead of

> _@variable_name_

. I see this mostly in the documentation for OPTIMIZE FOR on this page, but the entire page probably could use a formatting audit.


Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Pri1 cba doc-bug sqprod t-sqtech

All 5 comments

Since https://github.com/MicrosoftDocs/sql-docs/blob/00350f6ffb73c2c0d99beeded61c5b9baa63d171/docs/t-sql/queries/hints-transact-sql-query.md seems to render things correctly, perhaps the markdown renderer used by the publishing process to docs.microsoft.com itself is broken.

@binki - Thanks Nathan!

@MightyPen - Hey Gene, do you know why this might be broken on the live page?

@VanMSFT Van, I too am surprised to see that _@variable\_name_ does not render to look like simply italicized.

I will assign this Issue 2859 to myself.
Thanks. G
. .

Testing with new PR #11850.

  • https://github.com/MicrosoftDocs/sql-docs-pr/pull/11850

Fixed, for this article, by PR 11850.
The gist is that now the AT-SIGN @ must also be escaped (with a backslash) in some cases.
Or @ can be HTML encoded as @.

I will mention this Issue #2859 to Tami_F, so that she can convey to her people.
Thanks. G.


@binki Hi Nathan, I am now Closing this Issue #2859.
The @ notification mechanism continues to work even after an item is Closed, in case further communication is needed.
Thank you for submitting this Issue. We hope to hear from you again.

cc: @VanMSFT

Was this page helpful?
0 / 5 - 0 ratings

Related issues

alexmbaker picture alexmbaker  Â·  16Comments

calebsyring picture calebsyring  Â·  8Comments

rayswebpresence picture rayswebpresence  Â·  9Comments

fwd079 picture fwd079  Â·  23Comments

swanderz picture swanderz  Â·  9Comments