Skip to content

Commit 1c840ab

Browse files
bkoelmandennisdoomen
authored andcommitted
Just a few nits (#188)
1 parent 7a66f74 commit 1c840ab

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

_includes/0001_Introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## 1.1. What is this?
22

3-
This document attempts to provide guidelines (or coding standards if you like) for all versions of C# up to and including that are both valuable and pragmatic. Of course, if you create such a document you should practice what you preach. So rest assured, these guidelines are representative to what we at [Aviva Solutions](https://www.avivasolutions.nl) do in our day-to-day work. Notice that not all guidelines have a clear rationale. Some of them are simply choices we made at Aviva Solutions. In the end, it doesn't matter what choice you made, as long as you make one and apply it consistently.
3+
This document attempts to provide guidelines (or coding standards if you like) for all versions of C# up to and including 7.3 that are both valuable and pragmatic. Of course, if you create such a document you should practice what you preach. So rest assured, these guidelines are representative to what we at [Aviva Solutions](https://www.avivasolutions.nl) do in our day-to-day work. Notice that not all guidelines have a clear rationale. Some of them are simply choices we made at Aviva Solutions. In the end, it doesn't matter what choice you made, as long as you make one and apply it consistently.
44

55
## 1.2. Why would you use this document?
66

_pages/1100_MemberDesignGuidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ You generally don't want callers to be able to change an internal collection, so
4646

4747
### <a name="av1135"></a> Properties, arguments and return values representing strings or collections should never be `null` (AV1135) ![](/assets/images/1.png)
4848

49-
Returning `null` can be unexpected by the caller. Always return an empty collection or an empty string instead of a `null` reference. When your member return `Task` or `Task<T>`, return `Task.CompletedTask` or `Task.FromResult()`. This also prevents cluttering your code base with additional checks for `null`, or even worse, `string.IsNullOrEmpty()`.
49+
Returning `null` can be unexpected by the caller. Always return an empty collection or an empty string instead of a `null` reference. When your member returns `Task` or `Task<T>`, return `Task.CompletedTask` or `Task.FromResult()`. This also prevents cluttering your code base with additional checks for `null`, or even worse, `string.IsNullOrEmpty()`.
5050

5151
### <a name="av1137"></a> Define parameters as specific as possible (AV1137) ![](/assets/images/2.png)
5252

_pages/Cheatsheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ NOTE: Requires Markdown Extra. See http://michelf.ca/projects/php-markdown/extra
136136
<td class="column" markdown="1">
137137
<div class="sidebar">
138138

139-
| **Pascal Casing** | |
139+
| **Symbol kind** | **Example** |
140140
|:--------------------------------------|-------------------------------------------------------------|
141141
| Namespace | `System.Drawing` |
142142
| Type parameter | `TView` |

0 commit comments

Comments
 (0)