Skip to content

Commit ae07a0e

Browse files
committed
Apply markdown formatting
1 parent bd3d9c2 commit ae07a0e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

notebooks/contributing/formatting.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Every tutorial notebook requires an introduction section. The Markdown cells req
1919
The first cell contains the title and the author for the tutorial. It is formatted as follows.
2020
The title is in quotations. You will need to add yourself as an author in the `myst.yml` file in the root directory of the repository.
2121

22-
```
22+
```yaml
2323
---
2424
title: "My Notebook Title In Quotes"
2525
authors:
@@ -91,13 +91,13 @@ to a cluster computing environment.
9191

9292
In this cell, the contributor must provide a set of relevant keywords. E.g.
9393

94-
```
94+
```markdown
9595
**Keywords:** gravity inversion, sparse-norm inversion, integral formulation, tree mesh.
9696
```
9797

9898
Next, the contributor must provide a summary of the tutorial. The summary should be roughly one paragraph. If your tutorial focusses on particular functionality within SimPEG, please link to the API documentation. Also, link to tutorials you feel the reader should have already worked through. E.g.
9999

100-
```
100+
```markdown
101101
**Summary:** Here we invert gravity anomaly data to recover a density contrast model.
102102
We demonstrate two approaches for recovering a density contrast model:
103103

@@ -115,7 +115,7 @@ Anomaly Data](fwd_gravity_anomaly_3d.ipynb) tutorial before working through this
115115

116116
Finally, the contributor must provide learning objectives using a bullet list. E.g.
117117

118-
```
118+
```markdown
119119
**Learning Objectives:**
120120

121121
- How geophysical inversion is carried out using SimPEG.
@@ -190,7 +190,7 @@ Here, the contributor must:
190190

191191
E.g.
192192

193-
```
193+
```markdown
194194
## Define the Survey
195195

196196
Surveys within SimPEG generally require the user to create and connect three
@@ -215,7 +215,7 @@ which are to be measured. For the tutorial simulation, the receivers are located
215215
If something has been thoroughly explained in an introductory tutorial, you can avoid repetition by linking to that tutorial.
216216
However, the choice in values used in your tutorial should always be stated. E.g.
217217

218-
```
218+
```markdown
219219
## Assign Uncertainties
220220

221221
Approaches for applying reasonable uncertainties to normalized voltage and apparent

0 commit comments

Comments
 (0)