dotnet / dotnet/dotnet-api-docs

List sample path for each Environment.SpecialFolder field and update the description of the fields for targeting to multiple platforms.

Aperta
#3,591 2 commenti 1 reazione 0 assegnatari Vedi su GitHub
area-System.Runtime Pri3 untriaged
Lingua principale
C#
Stelle
950
Fork
1.7k
Merge medio
2g 19h
PR unite (30g)
52

Descrizione

[Current document for `Environment.SpecialFolder`](
https://docs.microsoft.com/zh-cn/dotnet/api/system.environment.specialfolder?view=netcore-2.0) only lists the meaning of each field on Windows. There're several problems since .NET Core targets multiple platform:

1. The field description is not accuracy. For instance, `ProgramFilesX86` indicates nothing for Linux and Mac. We need to let user know what platforms are supported for each field.
2. When it comes only to Windows, we probably are able to guess what these fields stand for. However, .NET core is now targeting to multiple platforms. Without explicit examples, people are confusing about the value of the fields. It would be great if we list sample path for each `Environment.SpecialFolder` field to make it more intuitive. It'll save a lot of time for developers.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dalla documentazione collegata di Environment.SpecialFolder e rivedi la descrizione di ogni campo. Identifica quali piattaforme supportano ciascun campo e documenta un percorso di esempio per ognuno; il lavoro è completo quando le descrizioni e gli esempi rendono chiaro il comportamento specifico della piattaforma.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.