Skip to content

Commit 5eec482

Browse files
committed
docs: Use @milancurcic's wording 4 naming section
1 parent 7401a19 commit 5eec482

File tree

1 file changed

+5
-25
lines changed

1 file changed

+5
-25
lines changed

STYLE_GUIDE.md

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -33,31 +33,11 @@ focus on the semantics of the proposed changes rather than style and formatting.
3333

3434
## Variable and procedure naming
3535

36-
Variable names should be descriptive, and not artificially short.
37-
By default, where it makes sense to do so, variable names shall be made up of one or more full words separated by an underscore.
38-
For cases where a conventional & appropriate shortening of a word is used then the underscore may be omitted.
39-
40-
Examples:
41-
42-
__GOOD__:
43-
44-
``` fortran
45-
logical :: has_failed
46-
real function linspace(...)
47-
```
48-
49-
__BAD__:
50-
51-
``` fortran
52-
logical :: has_failed
53-
real function lin_space(...)
54-
```
55-
56-
## Keyword case
57-
58-
Fortran keywords should __*not*__ be UPPERCASE.
59-
Modern editors and IDEs can highlight Fortran syntax and UPPERCASE keywords.
60-
UPPERCASE keywords give Fortran source code the appearance of being antiquated.
36+
* Variable and procedure names, as well as Fortran keywords, should be written in lowercase
37+
* Variable and procedure names should be made up of one or more full words separated by an underscore,
38+
for example `has_failed` is preferred over `hasfailed`
39+
* Where conventional and appropriate shortening of a word is used then the underscore may be omitted,
40+
for example `linspace` is preferred over `lin_space`
6141

6242
## End <scope> block closing statements
6343

0 commit comments

Comments
 (0)