Skip to content

Commit ec47b93

Browse files
dccowanlheagy
andauthored
Update notebooks/contributing/formatting.md
Co-authored-by: Lindsey Heagy <[email protected]>
1 parent ae07a0e commit ec47b93

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

notebooks/contributing/formatting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Tutorial Structure and Formatting Requirements
22
==============================================
33

4-
To ensure quality and consistency, the [Jupyter Notebooks](https://jupyter.org/) containing tutorials must follow strict structure and formatting requirements. The contents of each notebooks must be parsed sensibly into a set of sections. Sufficient explanation and links to API documentation are required when presenting functionality. Each section within a tutorial contains a combination of [Markdown](https://www.markdownguide.org/getting-started/) and coding cells. Our notebooks use the functionality in [MyST Parser](https://myst-parser.readthedocs.io/en/latest/) to augment the contents of Markdown cells. Before moving forward, we advise the contributor to:
4+
To ensure quality and consistency, the [Jupyter Notebooks](https://jupyter.org/) follow a structured template. The contents of each notebooks are to be parsed sensibly into a set of sections. Sufficient explanation and links to API documentation are requested when presenting functionality. Each section within a tutorial contains a combination of [Markdown](https://www.markdownguide.org/getting-started/) and coding cells. Our notebooks use the functionality in [MyST Parser](https://myst-parser.readthedocs.io/en/latest/) to augment the contents of Markdown cells. Before moving forward, we advise the contributor to:
55

66
* Be familiar with the structure and formatting that is used by most forward simulation and inversion tutorials. E.g. [3D Forward Simulation of Gravity Anomaly Data](../03-gravity/fwd_gravity_anomaly_3d.ipynb) and [3D Inversion of Gravity Anomaly Data](../03-gravity/inv_gravity_anomaly_3d.ipynb).
77

0 commit comments

Comments
 (0)