dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)
https://docs.microsoft.com/dotnet/api/
Other
709 stars 1.56k forks source link

Member signatures in C# don't follow the official formatting rules #6790

Open MichalStrehovsky opened 3 years ago

MichalStrehovsky commented 3 years ago

E.g. the GC.AddMemoryPressure has the following signature format:

https://github.com/dotnet/dotnet-api-docs/blob/54e27a3d78dcbaedc38a38478cdaefa0be962936/xml/System/GC.xml#L112

Notice the space before the parentheses. This is not how C# signatures are formatted in the rest of the repo or samples. Instead of

public static void AddMemoryPressure (long bytesAllocated);

This should be:

public static void AddMemoryPressure(long bytesAllocated);
dotnet-issue-labeler[bot] commented 3 years ago

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

gewarren commented 3 years ago

@mimisasouvanh Do you have an existing work item for this or should I create a new one?

gewarren commented 3 years ago

I logged https://dev.azure.com/ceapex/Engineering/_workitems/edit/439528 for this.