Skip to content

Commit 8b25413

Browse files
committed
Doc: Format STYLE_GUIDE play nice w/ GFM & PyMD
- Try to format some code in such a way that the rendering is OK with GFM and python markdown (FORD)
1 parent a2dfb48 commit 8b25413

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

STYLE_GUIDE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,21 +44,21 @@ focus on the semantics of the proposed changes rather than style and formatting.
4444

4545
## Attributes
4646

47+
<!-- ATTENTION! This section includes intentional trailing whitespace to get decent formatting with GFM and Python Markdown. -->
48+
4749
* Always specify `intent` for dummy arguments.
4850
* Don't use `dimension` attribute to declare arrays because it is less verbose.
49-
Use this:
50-
51+
Use this:
5152
```
5253
real, allocatable :: a(:), b(:,:)
53-
```
54-
55-
instead of:
56-
54+
```
55+
instead of:
5756
```
5857
real, dimension(:), allocatable :: a
59-
real, dimension(:,:), allocatable :: b
58+
```
6059
```
61-
60+
real, dimension(:,:), allocatable :: b
61+
```
6262
When defining many arrays of the same dimension, `dimension` can be used as an exception if it makes the code less verbose.
6363
* If the `optional` attribute is used to declare a dummy argument, it should follow the `intent` attribute.
6464

0 commit comments

Comments
 (0)