Automatically add boilerplate summary for auto-added parameterless constructors
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- csharp
- Ambito
- documentation, tooling
Direzione di ricerca
Confronta le voci generate di runtime\artifacts\bin\System.ComponentModel.TypeConverter\Release\net7.0\System.ComponentModel.TypeConverter.xml con i file XML corrispondenti di dotnet-api-docs per HalfConverter, Int128Converter e UInt128Converter. Verifica se i costruttori senza parametri sono generati dal compilatore o mancano a causa dell’artifacts path, quindi esamina il comportamento di sincronizzazione e concorda un riepilogo generico. Il lavoro è concluso quando la causa è stata stabilita e sono stati definiti il trattamento del boilerplate e la formulazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
HalfConverter, Int128Converter or UInt128Converter, have their documentation xml file created in this location:
runtime\artifacts\bin\System.ComponentModel.TypeConverter\Release\net7.0\System.ComponentModel.TypeConverter.xml
None of these 3 APIs have an xml entry for a parameterless constructor, but it gets added to the dotnet-api-docs file automatically anyway. According to this programming guide doc, it's valid.
To fix this:
- We need to agree on a generic boilerplate message that would apply to all APIs. Something like:
Creates a new <see cref=”T:Full.Name.Of.Type”/> instance with default values.
- We need investigate if it’s possible to determine if a parameterless constructor was autogenerated by the compiler and that’s why I was unable to find its docs in the intellisense xml files, or if the problem was that the user provided the wrong artifacts path which does not contain the xml file with that type’s docs.
- Lingua principale
- C#
- Stelle
- 14
- Fork
- 22
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
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 dotnet/api-docs-sync
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 42/100
dotnet/api-docs-sync#182 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
dotnet/api-docs-sync#181 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
dotnet/api-docs-sync#180 · 1 commento ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
dotnet/api-docs-sync#179 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
dotnet/api-docs-sync#178 · 1 commento ·
Tutte le issue di dotnet/api-docs-sync
Issue simili
-
subsystem: UI
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
Open-Systems-Pharmacology/PK-Sim#3812 ·
I maintainer di solito rispondono entro 1 giorno
-
[C#]:主页联网更新的提示投稿横幅指向错误Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
PCL-Community/PCL-CE#3652 ·
I maintainer di solito rispondono entro 1 giorno
-
bug effort:S P3
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
nightscout/nocturne#2012 ·
I maintainer di solito rispondono entro 1 giorno
-
area:frontend bug FE P3
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
klasolsson81/jobbliggaren#2010 ·
I maintainer di solito rispondono entro 1 giorno
-
[aw] Upgrade availableApertaagentic-workflows untriaged
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 65/100
I maintainer di solito rispondono entro 1 giorno