Skip to content

Commit

Permalink
chore(docs): add FIXME comments for module docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
engeir committed Dec 5, 2023
1 parent 9232573 commit 9d7d383
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/paper1_code/load/g16.py
@@ -1,5 +1,7 @@
"""Load Gregory et al. (2016) data."""

# FIXME: add doi.

import pathlib
import sys
from typing import Literal, Self
Expand Down
2 changes: 2 additions & 0 deletions src/paper1_code/load/j05.py
@@ -1,5 +1,7 @@
"""Load Jones et al. (2005) data."""

# FIXME: add doi.


def get_so2_j05() -> float:
"""Based on the paper by Jones et al. (2005).
Expand Down
2 changes: 2 additions & 0 deletions src/paper1_code/load/m20.py
Expand Up @@ -3,6 +3,8 @@
See ...
"""

# FIXME: add doi.

import datetime
import pathlib

Expand Down
2 changes: 2 additions & 0 deletions src/paper1_code/load/ob16.py
@@ -1,5 +1,7 @@
"""Load Otto-Bliesner et al. 2016 data."""

# FIXME: add doi.

import datetime
import itertools
import pathlib
Expand Down
2 changes: 2 additions & 0 deletions src/paper1_code/load/pinatubo.py
@@ -1,5 +1,7 @@
"""Load Mt. Pinatubo data."""

# FIXME: add doi.


def get_so2_pinatubo() -> float:
"""Get SO2 injected values based on observational data.
Expand Down
2 changes: 2 additions & 0 deletions src/paper1_code/load/t10.py
@@ -1,5 +1,7 @@
"""Load Timmreck et al. 2010 data."""

# FIXME: add doi.


def get_so2_t10() -> float:
"""Based on the paper by Timmreck et al. (2010).
Expand Down
2 changes: 2 additions & 0 deletions src/paper1_code/load/tambora.py
@@ -1,5 +1,7 @@
"""Load Mt. Tambora data."""

# FIXME: add doi.


def get_so2_tambora() -> float:
"""Get the SO2 injection used in VolMIP volc-long-eq for the Tambora eruption.
Expand Down

0 comments on commit 9d7d383

Please sign in to comment.