Skip to content

Commit bedf210

Browse files
committed
Proper capitalizations and terms
1 parent eac0325 commit bedf210

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# cos-guidelines
1+
# Caché ObjectScript (COS) Code Guidelines
2+
23
This is the first approximation of Caché ObjectScript (COS) guidelines we use for github.com/intersystems-ru projects. There are mandatory and recommended parts.
34

45
We do not plan to be very restrictive, but want be rather flexible enough and allow any *reasonable* style.
@@ -7,17 +8,17 @@ If there is some style already established in the class or utility being modifie
78
to continue use that same style, than introducing yet another one, which may be more recommended
89
but which will be introducing some unnecessary inconsistency.
910

10-
## Cheat sheet
11+
## Quick Reference Guide
1112

12-
For COS cheat sheet refer [here](COSQuickRef.md).
13+
For Caché ObjectScript quick reference guide see [here](COSQuickRef.md).
1314

14-
## Mandatory part
15+
## Mandatory Part
1516

1617
* Only "modern" syntax permitted, dotted syntax is not generally allowed (with few exceptions);
1718
* No short name for statements keywords or built-in functions allowed - use fully expanded names;
1819
* Comment your code appropriately, use English in comments to make your code easy to understand by your international colleagues. Same English-based rule applies to global, local, and type names.
1920

20-
## Recommended part
21+
## Recommended Part
2122
* We recommend to use fully expanded keyword or function name in lower case or capitalized. Whatever you'll select should be consistent across class or utility, i.e.
2223
```
2324
If (expression) {

0 commit comments

Comments
 (0)