Skip to content

Commit 26c8a62

Browse files
Added blurbs to config.json (#1537)
* Added blurbs to config.json * Update concepts/chars/.meta/config.json Co-authored-by: Erik Schierboom <[email protected]> * Update concepts/classes/.meta/config.json Co-authored-by: Erik Schierboom <[email protected]> * Add more blurbs to config.json Co-authored-by: Erik Schierboom <[email protected]>
1 parent 133beae commit 26c8a62

File tree

27 files changed

+83
-48
lines changed

27 files changed

+83
-48
lines changed

concepts/arrays/.meta/config.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
2-
"blurb": "TODO: add blurb for arrays concept",
2+
"blurb": "Arrays are a collection of multiple values of the same type.",
33
"authors": [
44
"ErikSchierboom"
55
],
6-
"contributors": []
6+
"contributors": [
7+
"yzAlvin"
8+
]
79
}

concepts/attributes/.meta/config.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
{
2-
"blurb": "TODO: add blurb for attributes concept",
2+
"blurb": "C# attributes associate metadata to supported attribute targets.",
33
"authors": [
44
"ErikSchierboom"
55
],
66
"contributors": [
7-
"valentin-p"
7+
"valentin-p",
8+
"yzAlvin"
89
]
910
}

concepts/booleans/.meta/config.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
2-
"blurb": "TODO: add blurb for booleans concept",
2+
"blurb": "Booleans are either true or false. They support NOT, AND, and OR operators.",
33
"authors": [
44
"ErikSchierboom"
55
],
6-
"contributors": []
6+
"contributors": [
7+
"yzAlvin"
8+
]
79
}

concepts/casting/.meta/config.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
{
2-
"blurb": "TODO: add blurb for casting concept",
2+
"blurb": "C# allows for casting and type conversion.",
33
"authors": [
44
"mikedamay"
55
],
66
"contributors": [
7-
"ErikSchierboom"
7+
"ErikSchierboom",
8+
"yzAlvin"
89
]
910
}

concepts/chars/.meta/config.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
{
2-
"blurb": "TODO: add blurb for chars concept",
2+
"blurb": "A char is a type that represents a Unicode UTF-16 character. Strings are a sequence of chars.",
33
"authors": [
44
"mikedamay"
55
],
66
"contributors": [
7-
"ErikSchierboom"
7+
"ErikSchierboom",
8+
"yzAlvin"
89
]
910
}

concepts/classes/.meta/config.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
2-
"blurb": "TODO: add blurb for classes concept",
2+
"blurb": "A class in C# is made up of its fields and methods. They are templates for creating objects with.",
33
"authors": [
44
"ErikSchierboom"
55
],
6-
"contributors": []
6+
"contributors": [
7+
"yzAlvin"
8+
]
79
}
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{
2-
"blurb": "TODO: add blurb for compound-assignment concept",
2+
"blurb": "C# allows compound assignment in the form x op= y.",
33
"authors": ["TODO: add author"],
4-
"contributors": []
4+
"contributors": [
5+
"yzAlvin"
6+
]
57
}

concepts/compound-assignment/about.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ features &= ~PhoneFeatures.Call;
1111
```
1212

1313
[compound-assignment]: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/operators/bitwise-and-shift-operators#compound-assignment
14+
[compound-assignment-alt]: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/expressions#compound-assignment
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{
2-
"blurb": "TODO: add blurb for const-readonly concept",
2+
"blurb": "A const allows you to specify fields where their value is known at compile time and will not change during the runtime of the program.",
33
"authors": ["TODO: add author"],
4-
"contributors": []
4+
"contributors": [
5+
"yzAlvin"
6+
]
57
}
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
2-
"blurb": "TODO: add blurb for constructors concept",
2+
"blurb": "Creating an instance of a class is done using its constructor.",
33
"authors": [
44
"ErikSchierboom"
55
],
6-
"contributors": []
6+
"contributors": [
7+
"yzAlvin"
8+
]
79
}

concepts/datetimes/.meta/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"blurb": "TODO: add blurb for datetimes concept",
2+
"blurb": "Datetimes are objects containing date and time information",
33
"authors": [
44
"ErikSchierboom"
55
],
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
{
2-
"blurb": "TODO: add blurb for defensive-copying concept",
2+
"blurb": "Defensive-copying protects your program from unexpected or malicious behaviour.",
33
"authors": [
44
"mikedamay"
55
],
66
"contributors": [
7-
"ErikSchierboom"
7+
"ErikSchierboom",
8+
"yzAlvin"
89
]
910
}
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
{
2-
"blurb": "TODO: add blurb for dictionaries concept",
2+
"blurb": "Dictionaries are a collection of key: value pairs.",
33
"authors": [
44
"mikedamay"
55
],
66
"contributors": [
77
"ErikSchierboom",
8-
"valentin-p"
8+
"valentin-p",
9+
"yzAlvin"
910
]
1011
}
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
2-
"blurb": "TODO: add blurb for do-while-loops concept",
2+
"blurb": "A do-while loops is similar to a while loop but code in the loop executed at least once.",
33
"authors": [
44
"ErikSchierboom"
55
],
6-
"contributors": []
6+
"contributors": [
7+
"yzAlvin"
8+
]
79
}

concepts/do-while-loops/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# About
22

3-
To repeatedly execute logic, one can use loops. If the code in a loop should always be executed at least one, a `do/while` loop can be used:
3+
To repeatedly execute logic, one can use loops. If the code in a loop should always be executed at least once, a `do/while` loop can be used:
44

55
```csharp
66
int x = 0;

concepts/exceptions/.meta/config.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
{
2-
"blurb": "TODO: add blurb for exceptions concept",
2+
"blurb": "Exceptions should be thrown when an error that needs special handling occurs.",
33
"authors": [
44
"archrisV"
55
],
66
"contributors": [
7-
"valentin-p"
7+
"valentin-p",
8+
"yzAlvin"
89
]
910
}

concepts/exceptions/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# About
22

3-
It is important to note that `exceptions` should be used in cases where something exceptional happens, an error that needs special handeling. It should not be used for control-flow of a program, as that is considered bad design, which often leads to bad performance and maintainability.
3+
It is important to note that `exceptions` should be used in cases where something exceptional happens, an error that needs special handling. It should not be used for control-flow of a program, as that is considered bad design, which often leads to bad performance and maintainability.
44

55
Some of the more common exceptions include `IndexOutOfRangeException`, `ArgumentOutOfRangeException`, `NullReferenceException`, `StackOverflowException`, `ArgumentException`, `InvalidOperationException` and `DivideByZeroException`.
66

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
{
2-
"blurb": "TODO: add blurb for expression-bodied-members concept",
2+
"blurb": "An expression-bodied-member often produces more concise and readable code than the traditional block-body.",
33
"authors": [
44
"mikedamay"
55
],
66
"contributors": [
7-
"ErikSchierboom"
7+
"ErikSchierboom",
8+
"yzAlvin"
89
]
910
}
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
2-
"blurb": "TODO: add blurb for floating-point-numbers concept",
2+
"blurb": "The three floating-point types in C# are: double, float and decimal.",
33
"authors": [
44
"ErikSchierboom"
55
],
6-
"contributors": []
6+
"contributors": [
7+
"yzAlvin"
8+
]
79
}

concepts/for-loops/.meta/config.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
2-
"blurb": "TODO: add blurb for for-loops concept",
2+
"blurb": "For-loops allow for iteration over a specified range, with a boolean condition to indicate when to stop, and an increment to indicate how much to go up or down by.",
33
"authors": [
44
"ErikSchierboom"
55
],
6-
"contributors": []
6+
"contributors": [
7+
"yzAlvin"
8+
]
79
}
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
2-
"blurb": "TODO: add blurb for foreach-loops concept",
2+
"blurb": "Foreach-loops allow for iteration over a collection, iterating over ALL elements.",
33
"authors": [
44
"ErikSchierboom"
55
],
6-
"contributors": []
6+
"contributors": [
7+
"yzAlvin"
8+
]
79
}
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
{
2-
"blurb": "TODO: add blurb for generic-types concept",
2+
"blurb": "Generic-types allow for classes and methods that defer the specification of one or more types until the class or method is declared and instantiated by client code.",
33
"authors": [
44
"mikedamay"
55
],
66
"contributors": [
7-
"ErikSchierboom"
7+
"ErikSchierboom",
8+
"yzAlvin"
89
]
910
}

concepts/generic-types/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ More [advanced generic techniques][generics] are discussed in (TODO cross-ref-tb
66

77
If you need a list of different types then you can use `List<Object>` but you will need to [down cast][casting] elements that you access in from the list.
88

9-
You should also be aware of `System.Collections.List` which you may encounter in legacy code. To all intents and purposes this behaves like `List<Oject>`.
9+
You should also be aware of `System.Collections.List` which you may encounter in legacy code. To all intents and purposes this behaves like `List<Object>`.
1010

1111
[generics]: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/generics/
1212
[casting]: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/types/casting-and-type-conversions
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
2-
"blurb": "TODO: add blurb for if-statements concept",
2+
"blurb": "An if statement can be used to conditionally execute code.",
33
"authors": [
44
"ErikSchierboom"
55
],
6-
"contributors": []
6+
"contributors": [
7+
"yzAlvin"
8+
]
79
}
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
2-
"blurb": "TODO: add blurb for inheritance concept",
2+
"blurb": "Inheritance allows derived classes to inherit the behavior and data of its parent class.",
33
"authors": [
44
"ErikSchierboom"
55
],
6-
"contributors": []
6+
"contributors": [
7+
"yzAlvin"
8+
]
79
}

concepts/interfaces/.meta/config.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
{
2-
"blurb": "TODO: add blurb for interfaces concept",
2+
"blurb": "Interfaces specify the behaviours of the classes that implement them, and are the primary means of decoupling the uses of a class from its implementation.",
33
"authors": [
44
"senal",
55
"mikedamay"
66
],
77
"contributors": [
8-
"ErikSchierboom"
8+
"ErikSchierboom",
9+
"yzAlvin"
910
]
1011
}

concepts/lists/.meta/config.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
{
2-
"blurb": "TODO: add blurb for lists concept",
2+
"blurb": "Lists in C# are collections of primitive values or instances of structs or classes.",
33
"authors": [
44
"mikedamay"
55
],
66
"contributors": [
7-
"ErikSchierboom"
7+
"ErikSchierboom",
8+
"yzAlvin"
89
]
910
}

0 commit comments

Comments
 (0)