IntelliSense XML: tables in a description are cut off, only an empty "<table>" is left

Open
#2,561 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript
Domain
documentation

Research direction

Start by tracing the conversion pipeline that produces Windows.Foundation.UniversalApiContract.xml from the Markdown sources; the issue does not name the generator files or tests. Compare how it handles the multiline HTML table in windows.globalization/numeralsystemidentifiers_bali.md and the Markdown table in windows.applicationmodel.store.preview/storeconfiguration_purchasepromptingpolicy.md. Done means both table forms survive as complete markup, or conversion omits the dangling empty <table> tag.

Written by the indexing model from the issue text.

Description

Pri3

Where it shows

The Windows SDK IntelliSense files (References\<sdk>\<contract>\<version>\en\*.xml; checked in the
Microsoft.Windows.SDK.Contracts NuGet package 10.0.29648.1000-preview, ref/netstandard2.0/en) keep no
table at all. In 19 descriptions the text ends with an escaped, empty <table>, and the rows are gone:

<member name="P:Windows.Globalization.NumeralSystemIdentifiers.Bali">
  <summary>Gets the identifier for the Balinese decimal numeral system.</summary>
  <returns>The string "Bali", which identifies the Balinese decimal numeral system. This system uses the following Unicode values:&lt;table&gt;</returns>
</member>
<member name="P:Windows.ApplicationModel.Store.Preview.StoreConfiguration.PurchasePromptingPolicy">
  <returns>A **UInt32** value that indicates whether the Microsoft Store prompts the user before making a purchase. &lt;table&gt;</returns>
</member>

Source (MicrosoftDocs/winrt-api, branch docs)

Both kinds of table are lost:

  • an HTML table written over several lines, windows.globalization/numeralsystemidentifiers_bali.md:

    The string "Bali", which identifies the Balinese decimal numeral system. This system uses the following Unicode values:<table>
       <tr><th>Unicode code point</th><th>Corresponding Latin digit</th></tr>
       <tr><td>U+1B50</td><td>0</td></tr>
       ...
    
  • a Markdown table, windows.applicationmodel.store.preview/storeconfiguration_purchasepromptingpolicy.md:

    A **UInt32** value that indicates whether the Microsoft Store prompts the user before making a purchase.
    
    | Value | Description |
    |---|---|
    | **1** | The Microsoft Store prompts the end user before making a purchase. |
    | **0** | The Microsoft Store does not prompt the end user before making a purchase. |
    

The reference pages on learn.microsoft.com render both tables (for example,
https://learn.microsoft.com/uwp/api/windows.globalization.numeralsystemidentifiers.bali shows the ten
rows U+1B50 to U+1B59).

Affected members (all in Windows.Foundation.UniversalApiContract.xml)

Member Part
P:Windows.ApplicationModel.Store.Preview.StoreConfiguration.PurchasePromptingPolicy returns
M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetPurchasePromptingPolicyForUser(Windows.System.User) returns
P:Windows.ApplicationModel.Store.Preview.StorePreviewProductInfo.ProductType returns
P:Windows.Globalization.NumeralSystemIdentifiers.Bali, .Cham, .Kali, .Lana, .LanaTham, .Lepc, .Limb, .Mtei, .Saur returns
P:Windows.Media.MediaProperties.IMediaEncodingProperties.Type returns
P:Windows.UI.Text.ITextParagraphFormat.ListLevelIndex returns
M:Windows.UI.Text.ITextRange.GetCharacterUtf32(System.UInt32@,System.Int32) param offset
M:Windows.UI.Text.ITextSelection.MoveDown/MoveLeft/MoveRight/MoveUp(Windows.UI.Text.TextRangeUnit,System.Int32,System.Boolean) param unit

Expected

The table survives the conversion, as an HTML table, the way the Windows App SDK IntelliSense files keep
theirs: Microsoft.UI.Text.xml in Microsoft.WindowsAppSDK.WinUI 2.3.9 carries complete
<table><tr><th>…</th></tr><tr><td>…</td></tr></table> markup (escaped) for Microsoft.UI.Text members.
Failing that, the dangling <table> should not be written, so that the text does not end in a stray tag.

How it was found

A documentation generator that reads these files to put the descriptions into its own API reference.
A related loss in the same pipeline, for Markdown images in the Windows App SDK files, is reported in
MicrosoftDocs/winapps-winrt-api#136.

Dominant language
JavaScript
Stars
266
Forks
517
Avg merge
1m
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MicrosoftDocs/winrt-api

All issues in MicrosoftDocs/winrt-api

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.