Skip to content

Commit afab795

Browse files
committed
Sick fighting with markdown numbered list problems
Got rid of numbered lists, started to use bullets
1 parent d5f60cf commit afab795

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,39 @@ but will produce inconsistent results.
88

99
## Mandatory part
1010

11-
1. Only "modern" syntax permitted, dotted syntax is not generally allowed (with few exceptions)
12-
2. No short name for statements keywords allowed - use fully expanded keyword names. This same rule applie to builtin function names - they should be fully pronounced.
11+
* Only "modern" syntax permitted, dotted syntax is not generally allowed (with few exceptions)
12+
* No short name for statements keywords allowed - use fully expanded keyword names. This same rule applie to builtin function names - they should be fully pronounced.
1313

1414
## Recommended part
15-
1. We recommend to use fully expanded keyword in lower case or capitalized. Whatever you'll select should be consistent across class or utility, i.e.
15+
* We recommend to use fully expanded keyword in lower case or capitalized. Whatever you'll select should be consistent across class or utility, i.e.
1616
```
1717
If (expression) {
1818
Do ##class(Sample).%New(initexpresion)
19-
For i=1:1:10 {
19+
For i=1:1:10 {
2020
Write something, $Zversion, !
2121
}
22-
}
22+
}
2323
```
24-
or
24+
or
25+
2526
```
2627
if (expression) {
27-
do ##class(Sample).%New(initexpresion)
28+
do ##class(Sample).%New(initexpresion)
2829
for i=1:1:10 {
29-
write something, $zversion, !
30-
}
30+
write something, $zversion, !
31+
}
3132
}
32-
3333
```
34-
2. Use the reasonable name convention which is consistent across hierarchy. We recommend to use CamelCase for classes, methods and properties (e.g. `Sample.Person`, `OpenFile`, `LastIndex`, etc.), but smallCamelCase for local variables (e.g. `startDate`, `endDate`), but please be consistent and use local schea if it's different thancurrent recommendation.
35-
3. For better readablity please insert spaces after comma in argument list, i.e.
34+
* Use the reasonable name convention which is consistent across hierarchy. We recommend to use CamelCase for classes, methods and properties (e.g. `Sample.Person`, `OpenFile`, `LastIndex`, etc.), but smallCamelCase for local variables (e.g. `startDate`, `endDate`), but please be consistent and use local schea if it's different thancurrent recommendation.
35+
* For better readablity please insert spaces after comma in argument list, i.e.
3636
```
37-
Write 1, 2, 3
38-
Do ..Method(Arg1, Arg2, Arg3)
37+
Write 1, 2, 3
38+
Do ..Method(Arg1, Arg2, Arg3)
3939
```
40-
4. We recommend to use `#dim` statement for declaration of local variables types, e.g.
40+
* We recommend to use `#dim` statement for declaration of local variables types, e.g.
4141
```
42-
#dim array as %ArrayOfDataTypes = ##class(%ArrayOfDataTypes).%New()
43-
do array.SetAt(id, "id")
44-
#dim status As %Status = $$$OK
42+
#dim array as %ArrayOfDataTypes = ##class(%ArrayOfDataTypes).%New()
43+
do array.SetAt(id, "id")
44+
#dim status As %Status = $$$OK
4545
```
46-
This will help editor to provide better auto-complete, and eventually will be used by static checker for type informantion extraction.
46+
This will help editor to provide better auto-complete, and eventually will be used by static checker for type informantion extraction.

0 commit comments

Comments
 (0)