From c8541e9087b1753018d5a524bfc2e4bcf55f4d82 Mon Sep 17 00:00:00 2001 From: Ilya Date: Fri, 4 Dec 2020 09:37:47 +0500 Subject: [PATCH 1/2] Update dead link in Code Guidelines --- docs/dev-process/coding-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dev-process/coding-guidelines.md b/docs/dev-process/coding-guidelines.md index dab26aa5bf7..71217b00367 100644 --- a/docs/dev-process/coding-guidelines.md +++ b/docs/dev-process/coding-guidelines.md @@ -86,7 +86,7 @@ We also run the [.NET code formatter tool](https://github.com/dotnet/codeformatt * Make sure the added/updated comments are meaningful, accurate and easy to understand. -* Public members must use [doc comments](https://docs.microsoft.com/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). +* Public members must use [doc comments](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/). Internal and private members may use doc comments but it is not required. ## Performance Considerations From 361023dbd8f30a93e06518da76a2ce258b545381 Mon Sep 17 00:00:00 2001 From: Ilya Date: Fri, 4 Dec 2020 09:43:45 +0500 Subject: [PATCH 2/2] Address feedback --- docs/dev-process/coding-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dev-process/coding-guidelines.md b/docs/dev-process/coding-guidelines.md index 71217b00367..389981c3f7b 100644 --- a/docs/dev-process/coding-guidelines.md +++ b/docs/dev-process/coding-guidelines.md @@ -86,7 +86,7 @@ We also run the [.NET code formatter tool](https://github.com/dotnet/codeformatt * Make sure the added/updated comments are meaningful, accurate and easy to understand. -* Public members must use [doc comments](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/). +* Public members must use [doc comments](https://docs.microsoft.com/dotnet/csharp/programming-guide/xmldoc/). Internal and private members may use doc comments but it is not required. ## Performance Considerations