IntelliSense XML: tables in a description are cut off, only an empty "<table>" is left
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 52/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- javascript
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- JavaScript
- Stelle
- 266
- Fork
- 517
- Merge medio
- 1m
- PR unite (30g)
- 1
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di MicrosoftDocs/winrt-api
-
Pri3
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
MicrosoftDocs/winrt-api#2535 ·
-
Pri3
Difficoltà 4/5 3-5 giorni Idoneità per principianti 36/100
MicrosoftDocs/winrt-api#2564 · 1 commento ·
-
Pri3
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
MicrosoftDocs/winrt-api#2563 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 38/100
MicrosoftDocs/winrt-api#2555 · 1 commento ·
-
Pri3
Difficoltà 5/5 Più di una settimana Idoneità per principianti 42/100
MicrosoftDocs/winrt-api#2540 ·
Tutte le issue di MicrosoftDocs/winrt-api
Issue simili
-
bot:ai-assisted component:platform-js status:untriaged
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
midnightntwrk/platform-js#69 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 67/100
awesome-dsh-plugin/awesome-dsh-plugin#16639 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
I maintainer di solito rispondono entro 1 giorno
-
Falló el respaldo diarioAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
manuXD270516/descanso#80 ·
I maintainer di solito rispondono entro 2 giorni
-
needs verification
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
I maintainer di solito rispondono entro 13 giorni