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.

Open
#3,591 2 comments 1 reaction 0 assignees View on GitHub
area-System.Runtime Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

[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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.