IntelliSense XML: tables in a description are cut off, only an empty "<table>" is left
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
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:<table></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. <table></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
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from MicrosoftDocs/winrt-api
-
Pri3
Difficulty 1/5 Under an hour Newbie friendliness 88/100
MicrosoftDocs/winrt-api#2535 ·
-
Pri3
Difficulty 4/5 3-5 days Newbie friendliness 36/100
MicrosoftDocs/winrt-api#2564 · 1 comment ·
-
Pri3
Difficulty 3/5 1-2 days Newbie friendliness 35/100
MicrosoftDocs/winrt-api#2563 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
MicrosoftDocs/winrt-api#2555 · 1 comment ·
-
Pri3
Difficulty 5/5 Over a week Newbie friendliness 42/100
MicrosoftDocs/winrt-api#2540 ·
All issues in MicrosoftDocs/winrt-api
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
manuXD270516/descanso#80 ·
Maintainers usually reply within 2 days
-
feat: Warn while typing a forbidden character in a file namePossibly taken @Mittalnew claimed this today. Openapp Drive 📁 enhancement OO Docs
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
linagora/twake-drive#4620 · 1 comment ·
Maintainers usually reply within 1 day
-
国战吕蒙【谋断】问题Open
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Maintainers usually reply within 1 day
-
Edit: Hello TasteOpenchannels:edit check:passed
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
Maintainers usually reply within 1 day