Skip to content

Commit

Permalink
Update WRITING_DOCS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
revarbat authored Apr 12, 2019
1 parent ae4035d commit c49aeef
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions WRITING_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Documentation and example images are generated automatically from source code co
- `// Function: NAME`
- `// Constant: NAME`

##LibFile:
## LibFile:

LibFile blocks can be followed by multiple lines that can be added as markdown text after the header. Indentation is important, as it denotes the end of block.

Expand All @@ -23,7 +23,7 @@ LibFile blocks can be followed by multiple lines that can be added as markdown t
// The end of the block is denoted by a line without a comment.
```

##Section:
## Section:

Section blocks can be followed by multiple lines that can be added as markdown text after the header. Indentation is important, as it denotes the end of block.

Expand All @@ -47,7 +47,7 @@ Sections can also include Figures; images generated from code that is not shown
// cube([100,10,30], center=true);
```

##CommonCode:
## CommonCode:

CommonCode blocks can be used to denote code that can be shared between all of the Figure and Example blocks in the file, without being shown itself. Indentation is important. Less than three spaces indent denotes the end of the block

Expand All @@ -60,7 +60,7 @@ CommonCode blocks can be used to denote code that can be shared between all of t
// }
```

##Module:/Function:/Constant:
## Module:/Function:/Constant:

Module, Function, and Constant docs blocks all have a similar specific format. Most sub-blocks are optional, except the Module/Function/Constant line, and the Description block.

Expand Down

0 comments on commit c49aeef

Please sign in to comment.