From 5da0de8ec06520a23b1a04f7fa8e8194f1f30b67 Mon Sep 17 00:00:00 2001
From: Thomas Lazarus <lazarustda@gmail.com>
Date: Mon, 27 Feb 2023 06:23:49 -0600
Subject: [PATCH 01/10] Adds create_toc() to Card

---
 skops/card/_model_card.py | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/skops/card/_model_card.py b/skops/card/_model_card.py
index d5e0e55c..3a33fd23 100644
--- a/skops/card/_model_card.py
+++ b/skops/card/_model_card.py
@@ -1308,3 +1308,36 @@ def render(self) -> str:
             sections inserted.
         """
         return "\n".join(self._generate_card())
+
+    def _iterate_key_section_content(
+        self,
+        data: dict[str, Section],
+        level: int = 0,
+    ):
+        for key, val in data.items():
+            if not getattr(val, "visible", True):
+                continue
+
+            title = val.title
+            yield title, level
+
+            if val.subsections:
+                yield from self._iterate_key_section_content(
+                    val.subsections,
+                    level=level + 1,
+                )
+
+    def create_toc(self) -> str:
+        """Create a table of contents for the model card.
+
+
+        Returns
+        -------
+        toc : str
+            The table of contents for the model card formatted as a markdown string.
+        """
+        sections = []
+        for title, level in self._iterate_key_section_content(self._data):
+            sections.append(f"{'    ' * level}- [{title}](#{title})")
+
+        return "\n".join(sections)

From 96f84af51123efbc6403e7164cd014cade1b8a8f Mon Sep 17 00:00:00 2001
From: Thomas Lazarus <lazarustda@gmail.com>
Date: Mon, 27 Feb 2023 06:35:00 -0600
Subject: [PATCH 02/10] Updates changelog

---
 docs/changes.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/changes.rst b/docs/changes.rst
index 28fa9975..b151deed 100644
--- a/docs/changes.rst
+++ b/docs/changes.rst
@@ -14,6 +14,8 @@ v0.6
 - Added tabular regression example. :pr: `254` by `Thomas Lazarus`
 - All public ``scipy.special`` ufuncs (Universal Functions) are trusted by default
   by :func:`.io.load`. :pr:`295` by :user:`Omar Arab Oghli <omar-araboghli>`.
+- Add :func:`.Card.create_toc` to create a table of contents for the model card in markdown format.
+  :pr:`305` by :user:`Thomas Lazarus <lazarust>`.
 
 v0.5
 ----

From bffba13d23265a28b53cbea9b3b6321b600b8954 Mon Sep 17 00:00:00 2001
From: Thomas Lazarus <lazarustda@gmail.com>
Date: Tue, 28 Feb 2023 19:17:37 -0600
Subject: [PATCH 03/10] Adds Test

---
 skops/card/_model_card.py     |  2 +-
 skops/card/tests/test_card.py | 23 +++++++++++++++++++++++
 2 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/skops/card/_model_card.py b/skops/card/_model_card.py
index 3a33fd23..148610f9 100644
--- a/skops/card/_model_card.py
+++ b/skops/card/_model_card.py
@@ -1338,6 +1338,6 @@ def create_toc(self) -> str:
         """
         sections = []
         for title, level in self._iterate_key_section_content(self._data):
-            sections.append(f"{'    ' * level}- [{title}](#{title})")
+            sections.append(f"{'  ' * level}- {title}")
 
         return "\n".join(sections)
diff --git a/skops/card/tests/test_card.py b/skops/card/tests/test_card.py
index 9ad94277..45c498e7 100644
--- a/skops/card/tests/test_card.py
+++ b/skops/card/tests/test_card.py
@@ -1593,3 +1593,26 @@ def test_visibility_with_card_save(self, card):
             "Jane Doe"
         )
         assert loaded.strip() == expected
+
+
+class TestCardTableOfContents:
+    @pytest.fixture
+    def card(self):
+        model = LinearRegression()
+        card = Card(model=model)
+        return card
+
+    def test_toc(self, card):
+        card.add_model_plot()
+        card.add_hyperparams()
+        card.add_metrics(accuracy=0.1)
+        card.add_get_started_code()
+        toc = card.create_toc()
+        exptected_toc = (
+            "- Model description\n  - Intended uses & limitations\n  - Training"
+            " Procedure\n    - Hyperparameters\n    - Model Plot\n  - Evaluation"
+            " Results\n- How to Get Started with the Model\n- Model Card Authors\n-"
+            " Model Card Contact\n- Citation"
+        )
+
+        assert toc == exptected_toc

From b8ffe4ef7e44cd7281c75c6fb18b7e61f5c7c973 Mon Sep 17 00:00:00 2001
From: Thomas Lazarus <lazarustda@gmail.com>
Date: Tue, 28 Feb 2023 19:19:37 -0600
Subject: [PATCH 04/10] Fixes line length

---
 docs/changes.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/changes.rst b/docs/changes.rst
index 680fb870..ce058549 100644
--- a/docs/changes.rst
+++ b/docs/changes.rst
@@ -14,8 +14,8 @@ v0.6
 - Added tabular regression example. :pr: `254` by `Thomas Lazarus`
 - All public ``scipy.special`` ufuncs (Universal Functions) are trusted by default
   by :func:`.io.load`. :pr:`295` by :user:`Omar Arab Oghli <omar-araboghli>`.
-- Add :func:`.Card.create_toc` to create a table of contents for the model card in markdown format.
-  :pr:`305` by :user:`Thomas Lazarus <lazarust>`.
+- Add :func:`.Card.create_toc` to create a table of contents for the model card in
+  markdown format. :pr:`305` by :user:`Thomas Lazarus <lazarust>`.
 - Add example of using model card without the skops template. :pr:`291` by
   `Benjamin Bossan`_.
 

From c2602f0a440293cb2fd71c0a1c2679e367c71c05 Mon Sep 17 00:00:00 2001
From: Thomas Lazarus <lazarustda@gmail.com>
Date: Wed, 1 Mar 2023 21:02:17 -0600
Subject: [PATCH 05/10] Fixes from feedback

---
 skops/card/_model_card.py     |   2 +-
 skops/card/tests/test_card.py | 218 ++++++++++++++++++----------------
 2 files changed, 115 insertions(+), 105 deletions(-)

diff --git a/skops/card/_model_card.py b/skops/card/_model_card.py
index e9356681..a68eb9d2 100644
--- a/skops/card/_model_card.py
+++ b/skops/card/_model_card.py
@@ -1321,6 +1321,7 @@ def _iterate_key_section_content(
         data: dict[str, Section],
         level: int = 0,
     ):
+        """Iterate through the key sections and yield the title and level."""
         for key, val in data.items():
             if not getattr(val, "visible", True):
                 continue
@@ -1337,7 +1338,6 @@ def _iterate_key_section_content(
     def create_toc(self) -> str:
         """Create a table of contents for the model card.
 
-
         Returns
         -------
         toc : str
diff --git a/skops/card/tests/test_card.py b/skops/card/tests/test_card.py
index 45c498e7..fee207ba 100644
--- a/skops/card/tests/test_card.py
+++ b/skops/card/tests/test_card.py
@@ -153,7 +153,7 @@ def test_default(self, model_card):
             "Model description/Training Procedure/Model Plot"
         ).content
         # don't compare whole text, as it's quite long and non-deterministic
-        assert result.startswith("The model plot is below.\n\n<style>#sk-")
+        assert result.startswith("The model plot is below.<style>#sk-")
         assert "<style>" in result
         assert result.endswith(
             "<pre>LinearRegression()</pre></div></div></div></div></div>"
@@ -178,7 +178,7 @@ def test_model_diagram_false(self):
     def test_other_section(self, model_card):
         model_card.add_model_plot(section="Other section")
         result = model_card.select("Other section").content
-        assert result.startswith("The model plot is below.\n\n<style>#sk-")
+        assert result.startswith("The model plot is below.<style>#sk-")
         assert "<style>" in result
         assert result.endswith(
             "<pre>LinearRegression()</pre></div></div></div></div></div>"
@@ -189,7 +189,7 @@ def test_other_description(self, model_card):
         result = model_card.select(
             "Model description/Training Procedure/Model Plot"
         ).content
-        assert result.startswith("Awesome diagram below\n\n<style>#sk-")
+        assert result.startswith("Awesome diagram below<style>#sk-")
 
     @pytest.mark.parametrize("template", CUSTOM_TEMPLATES)
     def test_custom_template_no_section_raises(self, template):
@@ -253,7 +253,7 @@ def expected(self):
         if (major >= 1) and (minor >= 2):
             del lines[10]
 
-        table = "\n".join(lines)
+        table = "".join(lines)
         # remove multiple whitespaces and dashes, as they're not important and may
         # differ depending on OS
         table = _strip_multiple_chars(table, " ")
@@ -312,12 +312,12 @@ def test_add_twice(self, model_card):
         assert text1 == text2
 
     def test_hyperparameter_table_with_line_break(self):
-        # Hyperparameters can contain values with line breaks, "\n", in them. In
+        # Hyperparameters can contain values with line breaks, "", in them. In
         # that case, the markdown table is broken. Check that the hyperparameter
-        # table we create properly replaces the "\n" with "<br />".
+        # table we create properly replaces the "" with "<br />".
         class EstimatorWithLbInParams:
             def get_params(self, deep=False):
-                return {"fit_intercept": True, "n_jobs": "line\nwith\nbreak"}
+                return {"fit_intercept": True, "n_jobs": "linewithbreak"}
 
         model_card = Card(EstimatorWithLbInParams())
         section_name = "Model description/Training Procedure/Hyperparameters"
@@ -342,8 +342,8 @@ def test_empty_metrics_table(self, model_card):
         result = model_card.select("Model description/Evaluation Results").content
         expected = (
             "You can find the details about evaluation process and the evaluation "
-            "results.\n\n"
-            "| Metric   | Value   |\n"
+            "results."
+            "| Metric   | Value   |"
             "|----------|---------|"
         )
         assert result == expected
@@ -357,11 +357,11 @@ def test_multiple_metrics(self, model_card):
         result = model_card.select("Model description/Evaluation Results").content
         expected = (
             "You can find the details about evaluation process and the evaluation "
-            "results.\n\n"
-            "| Metric      |   Value |\n"
-            "|-------------|---------|\n"
-            "| acc         |     0.1 |\n"
-            "| f1          |     0.1 |\n"
+            "results."
+            "| Metric      |   Value |"
+            "|-------------|---------|"
+            "| acc         |     0.1 |"
+            "| f1          |     0.1 |"
             "| awesomeness |   123   |"
         )
         assert result == expected
@@ -371,9 +371,9 @@ def test_other_section(self, model_card):
         result = model_card.select("Other section").content
         expected = (
             "You can find the details about evaluation process and the evaluation "
-            "results.\n\n"
-            "| Metric   |   Value |\n"
-            "|----------|---------|\n"
+            "results."
+            "| Metric   |   Value |"
+            "|----------|---------|"
             "| accuracy |     0.9 |"
         )
         assert result == expected
@@ -541,15 +541,15 @@ def test_default_pickle(self, model_card):
         # by default, don't add a table, as there are no metrics
         result = model_card.select("How to Get Started with the Model").content
         expected = (
-            "Use the code below to get started with the model.\n\n"
-            "```python\n"
-            "import json\n"
-            "import pandas as pd\n"
-            "import joblib\n"
-            'model = joblib.load("my-model.pickle")\n'
-            'with open("config.json") as f:\n'
-            "    config = json.load(f)\n"
-            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))\n'
+            "Use the code below to get started with the model."
+            "```python"
+            "import json"
+            "import pandas as pd"
+            "import joblib"
+            'model = joblib.load("my-model.pickle")'
+            'with open("config.json") as f:'
+            "    config = json.load(f)"
+            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))'
             "```"
         )
         assert result == expected
@@ -558,15 +558,15 @@ def test_default_skops(self, model_card_skops):
         # by default, don't add a table, as there are no metrics
         result = model_card_skops.select("How to Get Started with the Model").content
         expected = (
-            "Use the code below to get started with the model.\n\n"
-            "```python\n"
-            "import json\n"
-            "import pandas as pd\n"
-            "import skops.io as sio\n"
-            'model = sio.load("my-model.skops")\n'
-            'with open("config.json") as f:\n'
-            "    config = json.load(f)\n"
-            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))\n'
+            "Use the code below to get started with the model."
+            "```python"
+            "import json"
+            "import pandas as pd"
+            "import skops.io as sio"
+            'model = sio.load("my-model.skops")'
+            'with open("config.json") as f:'
+            "    config = json.load(f)"
+            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))'
             "```"
         )
         assert result == expected
@@ -603,15 +603,15 @@ def test_other_filename(self, model_card):
         model_card.add_get_started_code(file_name="foobar.pkl")
         result = model_card.select("How to Get Started with the Model").content
         expected = (
-            "Use the code below to get started with the model.\n\n"
-            "```python\n"
-            "import json\n"
-            "import pandas as pd\n"
-            "import joblib\n"
-            'model = joblib.load("foobar.pkl")\n'
-            'with open("config.json") as f:\n'
-            "    config = json.load(f)\n"
-            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))\n'
+            "Use the code below to get started with the model."
+            "```python"
+            "import json"
+            "import pandas as pd"
+            "import joblib"
+            'model = joblib.load("foobar.pkl")'
+            'with open("config.json") as f:'
+            "    config = json.load(f)"
+            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))'
             "```"
         )
         assert result == expected
@@ -620,15 +620,15 @@ def test_other_model_format(self, model_card):
         model_card.add_get_started_code(model_format="skops")
         result = model_card.select("How to Get Started with the Model").content
         expected = (
-            "Use the code below to get started with the model.\n\n"
-            "```python\n"
-            "import json\n"
-            "import pandas as pd\n"
-            "import skops.io as sio\n"
-            'model = sio.load("my-model.pickle")\n'
-            'with open("config.json") as f:\n'
-            "    config = json.load(f)\n"
-            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))\n'
+            "Use the code below to get started with the model."
+            "```python"
+            "import json"
+            "import pandas as pd"
+            "import skops.io as sio"
+            'model = sio.load("my-model.pickle")'
+            'with open("config.json") as f:'
+            "    config = json.load(f)"
+            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))'
             "```"
         )
         assert result == expected
@@ -1139,7 +1139,7 @@ def expected_lines(self):
         )
         """
         expected = textwrap.dedent(card_repr).strip()
-        lines = expected.split("\n")
+        lines = expected.split("")
 
         # TODO: remove when dropping sklearn v0.24 and when dropping v1.1 and
         # below. This is because the "normalize" parameter was changed after
@@ -1162,7 +1162,7 @@ def expected_lines(self):
     @pytest.mark.parametrize("meth", [repr, str])
     def test_card_repr(self, card: Card, meth, expected_lines):
         result = meth(card)
-        expected = "\n".join(expected_lines)
+        expected = "".join(expected_lines)
         assert result == expected
 
     @pytest.mark.parametrize("meth", [repr, str])
@@ -1190,7 +1190,7 @@ def test_very_long_lines_are_shortened(self, card: Card, meth, expected_lines):
             "line very long line very long line ,"
         )
         expected_lines.insert(-1, extra_line)
-        expected = "\n".join(expected_lines)
+        expected = "".join(expected_lines)
 
         result = meth(card)
         assert result == expected
@@ -1201,7 +1201,7 @@ def test_without_model_attribute(self, card: Card, meth, expected_lines):
 
         # remove line 1 from expected results, which corresponds to the model
         del expected_lines[1]
-        expected = "\n".join(expected_lines)
+        expected = "".join(expected_lines)
 
         result = meth(card)
         assert result == expected
@@ -1227,7 +1227,7 @@ def test_with_metadata(self, card: Card, meth, expected_lines):
             "  metadata.foo={'bar': 123},",
             "  metadata.widget={...},",
         ]
-        expected = "\n".join(expected_lines[:2] + extra_lines + expected_lines[2:])
+        expected = "".join(expected_lines[:2] + extra_lines + expected_lines[2:])
 
         result = meth(card)
         assert result == expected
@@ -1251,7 +1251,7 @@ def test_model_card_repr(self, meth, suffix):
         card_from_path = self.path_to_card(file_name)
 
         result0 = meth(card_from_path)
-        expected = "Card(\n  model=LinearRegression(fit_intercept=False),"
+        expected = "Card(  model=LinearRegression(fit_intercept=False),"
         assert result0.startswith(expected)
 
         # change file name, same card should show different result
@@ -1259,7 +1259,7 @@ def test_model_card_repr(self, meth, suffix):
         file_handle, file_name = save_model_to_file(model, suffix)
         card_from_path.model = file_name
         result1 = meth(card_from_path)
-        expected = "Card(\n  model=LinearRegression(),"
+        expected = "Card(  model=LinearRegression(),"
         assert result1.startswith(expected)
 
         # change model on disk but keep same file name, should show different
@@ -1269,7 +1269,7 @@ def test_model_card_repr(self, meth, suffix):
             dump_fn = pickle.dump if suffix == ".pkl" else dump
             dump_fn(model, f)
         result2 = meth(card_from_path)
-        expected = "Card(\n  model=LinearRegression(fit_intercept=None),"
+        expected = "Card(  model=LinearRegression(fit_intercept=None),"
         assert result2.startswith(expected)
 
     @pytest.mark.parametrize("suffix", [".pkl", ".skops"])
@@ -1419,11 +1419,11 @@ class LineBreakInRepr:
             """Custom object whose repr has a line break"""
 
             def __repr__(self) -> str:
-                return "obj\nwith lb"
+                return "objwith lb"
 
         table_dict["with break"] = [
             LineBreakInRepr(),
-            "hi\nthere",
+            "hithere",
             """
 entry with
 line breaks
@@ -1520,13 +1520,13 @@ def card(self, template):
     def test_all_visible_by_default(self, card):
         rendered = card.render()
         expected = (
-            "# Model\n\n"
-            "Here goes model related stuff\n\n"
-            "## Metrics\n\n"
-            "123\n\n"
-            "## Bar\n\n"
-            "Baz\n\n"
-            "# Authors\n\n"
+            "# Model"
+            "Here goes model related stuff"
+            "## Metrics"
+            "123"
+            "## Bar"
+            "Baz"
+            "# Authors"
             "Jane Doe"
         )
         assert rendered.strip() == expected
@@ -1534,27 +1534,20 @@ def test_all_visible_by_default(self, card):
     def test_section_invisible(self, card):
         card.select("Model/Metrics").visible = False
         rendered = card.render()
-        expected = (
-            "# Model\n\n"
-            "Here goes model related stuff\n\n"
-            "## Bar\n\n"
-            "Baz\n\n"
-            "# Authors\n\n"
-            "Jane Doe"
-        )
+        expected = "# ModelHere goes model related stuff## BarBaz# AuthorsJane Doe"
         assert rendered.strip() == expected
 
     def test_restoring_visibility_works(self, card):
         card.select("Model/Metrics").visible = False
         card.select("Model/Metrics").visible = True
         expected = (
-            "# Model\n\n"
-            "Here goes model related stuff\n\n"
-            "## Metrics\n\n"
-            "123\n\n"
-            "## Bar\n\n"
-            "Baz\n\n"
-            "# Authors\n\n"
+            "# Model"
+            "Here goes model related stuff"
+            "## Metrics"
+            "123"
+            "## Bar"
+            "Baz"
+            "# Authors"
             "Jane Doe"
         )
         rendered = card.render()
@@ -1566,7 +1559,7 @@ def test_invisible_parent_section_hides_subsections(self, card):
         card.select("Model").visible = False
         # fmt: off
         expected = (
-            "# Authors\n\n"
+            "# Authors"
             "Jane Doe"
         )
         # fmt: on
@@ -1584,14 +1577,7 @@ def test_visibility_with_card_save(self, card):
         with open(file, "r") as f:
             loaded = f.read()
 
-        expected = (
-            "# Model\n\n"
-            "Here goes model related stuff\n\n"
-            "## Bar\n\n"
-            "Baz\n\n"
-            "# Authors\n\n"
-            "Jane Doe"
-        )
+        expected = "# ModelHere goes model related stuff## BarBaz# AuthorsJane Doe"
         assert loaded.strip() == expected
 
 
@@ -1600,19 +1586,43 @@ class TestCardTableOfContents:
     def card(self):
         model = LinearRegression()
         card = Card(model=model)
-        return card
-
-    def test_toc(self, card):
         card.add_model_plot()
         card.add_hyperparams()
         card.add_metrics(accuracy=0.1)
         card.add_get_started_code()
+        return card
+
+    def test_toc(self, card):
         toc = card.create_toc()
-        exptected_toc = (
-            "- Model description\n  - Intended uses & limitations\n  - Training"
-            " Procedure\n    - Hyperparameters\n    - Model Plot\n  - Evaluation"
-            " Results\n- How to Get Started with the Model\n- Model Card Authors\n-"
-            " Model Card Contact\n- Citation"
-        )
+        exptected_toc = [
+            "- Model description",
+            "  - Intended uses & limitations",
+            "  - Training Procedure",
+            "    - Hyperparameters",
+            "    - Model Plot",
+            "  - Evaluation Results",
+            "- How to Get Started with the Model",
+            "- Model Card Authors",
+            "- Model Card Contact",
+            "- Citation",
+        ]
+
+        assert toc == "\n".join(exptected_toc)
+
+    def test_toc_with_invisible_section(self, card):
+        section = card.select("Citation")
+        section.visible = False
+        toc = card.create_toc()
+        exptected_toc = [
+            "- Model description",
+            "  - Intended uses & limitations",
+            "  - Training Procedure",
+            "    - Hyperparameters",
+            "    - Model Plot",
+            "  - Evaluation Results",
+            "- How to Get Started with the Model",
+            "- Model Card Authors",
+            "- Model Card Contact",
+        ]
 
-        assert toc == exptected_toc
+        assert toc == "\n".join(exptected_toc)

From e564f69a5aa5c4029acd92df28c6ae9656edca28 Mon Sep 17 00:00:00 2001
From: Thomas Lazarus <lazarustda@gmail.com>
Date: Wed, 1 Mar 2023 21:14:41 -0600
Subject: [PATCH 06/10] Revert "Fixes from feedback"

This reverts commit c2602f0a440293cb2fd71c0a1c2679e367c71c05.
---
 skops/card/_model_card.py     |   2 +-
 skops/card/tests/test_card.py | 218 ++++++++++++++++------------------
 2 files changed, 105 insertions(+), 115 deletions(-)

diff --git a/skops/card/_model_card.py b/skops/card/_model_card.py
index a68eb9d2..e9356681 100644
--- a/skops/card/_model_card.py
+++ b/skops/card/_model_card.py
@@ -1321,7 +1321,6 @@ def _iterate_key_section_content(
         data: dict[str, Section],
         level: int = 0,
     ):
-        """Iterate through the key sections and yield the title and level."""
         for key, val in data.items():
             if not getattr(val, "visible", True):
                 continue
@@ -1338,6 +1337,7 @@ def _iterate_key_section_content(
     def create_toc(self) -> str:
         """Create a table of contents for the model card.
 
+
         Returns
         -------
         toc : str
diff --git a/skops/card/tests/test_card.py b/skops/card/tests/test_card.py
index fee207ba..45c498e7 100644
--- a/skops/card/tests/test_card.py
+++ b/skops/card/tests/test_card.py
@@ -153,7 +153,7 @@ def test_default(self, model_card):
             "Model description/Training Procedure/Model Plot"
         ).content
         # don't compare whole text, as it's quite long and non-deterministic
-        assert result.startswith("The model plot is below.<style>#sk-")
+        assert result.startswith("The model plot is below.\n\n<style>#sk-")
         assert "<style>" in result
         assert result.endswith(
             "<pre>LinearRegression()</pre></div></div></div></div></div>"
@@ -178,7 +178,7 @@ def test_model_diagram_false(self):
     def test_other_section(self, model_card):
         model_card.add_model_plot(section="Other section")
         result = model_card.select("Other section").content
-        assert result.startswith("The model plot is below.<style>#sk-")
+        assert result.startswith("The model plot is below.\n\n<style>#sk-")
         assert "<style>" in result
         assert result.endswith(
             "<pre>LinearRegression()</pre></div></div></div></div></div>"
@@ -189,7 +189,7 @@ def test_other_description(self, model_card):
         result = model_card.select(
             "Model description/Training Procedure/Model Plot"
         ).content
-        assert result.startswith("Awesome diagram below<style>#sk-")
+        assert result.startswith("Awesome diagram below\n\n<style>#sk-")
 
     @pytest.mark.parametrize("template", CUSTOM_TEMPLATES)
     def test_custom_template_no_section_raises(self, template):
@@ -253,7 +253,7 @@ def expected(self):
         if (major >= 1) and (minor >= 2):
             del lines[10]
 
-        table = "".join(lines)
+        table = "\n".join(lines)
         # remove multiple whitespaces and dashes, as they're not important and may
         # differ depending on OS
         table = _strip_multiple_chars(table, " ")
@@ -312,12 +312,12 @@ def test_add_twice(self, model_card):
         assert text1 == text2
 
     def test_hyperparameter_table_with_line_break(self):
-        # Hyperparameters can contain values with line breaks, "", in them. In
+        # Hyperparameters can contain values with line breaks, "\n", in them. In
         # that case, the markdown table is broken. Check that the hyperparameter
-        # table we create properly replaces the "" with "<br />".
+        # table we create properly replaces the "\n" with "<br />".
         class EstimatorWithLbInParams:
             def get_params(self, deep=False):
-                return {"fit_intercept": True, "n_jobs": "linewithbreak"}
+                return {"fit_intercept": True, "n_jobs": "line\nwith\nbreak"}
 
         model_card = Card(EstimatorWithLbInParams())
         section_name = "Model description/Training Procedure/Hyperparameters"
@@ -342,8 +342,8 @@ def test_empty_metrics_table(self, model_card):
         result = model_card.select("Model description/Evaluation Results").content
         expected = (
             "You can find the details about evaluation process and the evaluation "
-            "results."
-            "| Metric   | Value   |"
+            "results.\n\n"
+            "| Metric   | Value   |\n"
             "|----------|---------|"
         )
         assert result == expected
@@ -357,11 +357,11 @@ def test_multiple_metrics(self, model_card):
         result = model_card.select("Model description/Evaluation Results").content
         expected = (
             "You can find the details about evaluation process and the evaluation "
-            "results."
-            "| Metric      |   Value |"
-            "|-------------|---------|"
-            "| acc         |     0.1 |"
-            "| f1          |     0.1 |"
+            "results.\n\n"
+            "| Metric      |   Value |\n"
+            "|-------------|---------|\n"
+            "| acc         |     0.1 |\n"
+            "| f1          |     0.1 |\n"
             "| awesomeness |   123   |"
         )
         assert result == expected
@@ -371,9 +371,9 @@ def test_other_section(self, model_card):
         result = model_card.select("Other section").content
         expected = (
             "You can find the details about evaluation process and the evaluation "
-            "results."
-            "| Metric   |   Value |"
-            "|----------|---------|"
+            "results.\n\n"
+            "| Metric   |   Value |\n"
+            "|----------|---------|\n"
             "| accuracy |     0.9 |"
         )
         assert result == expected
@@ -541,15 +541,15 @@ def test_default_pickle(self, model_card):
         # by default, don't add a table, as there are no metrics
         result = model_card.select("How to Get Started with the Model").content
         expected = (
-            "Use the code below to get started with the model."
-            "```python"
-            "import json"
-            "import pandas as pd"
-            "import joblib"
-            'model = joblib.load("my-model.pickle")'
-            'with open("config.json") as f:'
-            "    config = json.load(f)"
-            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))'
+            "Use the code below to get started with the model.\n\n"
+            "```python\n"
+            "import json\n"
+            "import pandas as pd\n"
+            "import joblib\n"
+            'model = joblib.load("my-model.pickle")\n'
+            'with open("config.json") as f:\n'
+            "    config = json.load(f)\n"
+            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))\n'
             "```"
         )
         assert result == expected
@@ -558,15 +558,15 @@ def test_default_skops(self, model_card_skops):
         # by default, don't add a table, as there are no metrics
         result = model_card_skops.select("How to Get Started with the Model").content
         expected = (
-            "Use the code below to get started with the model."
-            "```python"
-            "import json"
-            "import pandas as pd"
-            "import skops.io as sio"
-            'model = sio.load("my-model.skops")'
-            'with open("config.json") as f:'
-            "    config = json.load(f)"
-            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))'
+            "Use the code below to get started with the model.\n\n"
+            "```python\n"
+            "import json\n"
+            "import pandas as pd\n"
+            "import skops.io as sio\n"
+            'model = sio.load("my-model.skops")\n'
+            'with open("config.json") as f:\n'
+            "    config = json.load(f)\n"
+            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))\n'
             "```"
         )
         assert result == expected
@@ -603,15 +603,15 @@ def test_other_filename(self, model_card):
         model_card.add_get_started_code(file_name="foobar.pkl")
         result = model_card.select("How to Get Started with the Model").content
         expected = (
-            "Use the code below to get started with the model."
-            "```python"
-            "import json"
-            "import pandas as pd"
-            "import joblib"
-            'model = joblib.load("foobar.pkl")'
-            'with open("config.json") as f:'
-            "    config = json.load(f)"
-            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))'
+            "Use the code below to get started with the model.\n\n"
+            "```python\n"
+            "import json\n"
+            "import pandas as pd\n"
+            "import joblib\n"
+            'model = joblib.load("foobar.pkl")\n'
+            'with open("config.json") as f:\n'
+            "    config = json.load(f)\n"
+            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))\n'
             "```"
         )
         assert result == expected
@@ -620,15 +620,15 @@ def test_other_model_format(self, model_card):
         model_card.add_get_started_code(model_format="skops")
         result = model_card.select("How to Get Started with the Model").content
         expected = (
-            "Use the code below to get started with the model."
-            "```python"
-            "import json"
-            "import pandas as pd"
-            "import skops.io as sio"
-            'model = sio.load("my-model.pickle")'
-            'with open("config.json") as f:'
-            "    config = json.load(f)"
-            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))'
+            "Use the code below to get started with the model.\n\n"
+            "```python\n"
+            "import json\n"
+            "import pandas as pd\n"
+            "import skops.io as sio\n"
+            'model = sio.load("my-model.pickle")\n'
+            'with open("config.json") as f:\n'
+            "    config = json.load(f)\n"
+            'model.predict(pd.DataFrame.from_dict(config["sklearn"]["example_input"]))\n'
             "```"
         )
         assert result == expected
@@ -1139,7 +1139,7 @@ def expected_lines(self):
         )
         """
         expected = textwrap.dedent(card_repr).strip()
-        lines = expected.split("")
+        lines = expected.split("\n")
 
         # TODO: remove when dropping sklearn v0.24 and when dropping v1.1 and
         # below. This is because the "normalize" parameter was changed after
@@ -1162,7 +1162,7 @@ def expected_lines(self):
     @pytest.mark.parametrize("meth", [repr, str])
     def test_card_repr(self, card: Card, meth, expected_lines):
         result = meth(card)
-        expected = "".join(expected_lines)
+        expected = "\n".join(expected_lines)
         assert result == expected
 
     @pytest.mark.parametrize("meth", [repr, str])
@@ -1190,7 +1190,7 @@ def test_very_long_lines_are_shortened(self, card: Card, meth, expected_lines):
             "line very long line very long line ,"
         )
         expected_lines.insert(-1, extra_line)
-        expected = "".join(expected_lines)
+        expected = "\n".join(expected_lines)
 
         result = meth(card)
         assert result == expected
@@ -1201,7 +1201,7 @@ def test_without_model_attribute(self, card: Card, meth, expected_lines):
 
         # remove line 1 from expected results, which corresponds to the model
         del expected_lines[1]
-        expected = "".join(expected_lines)
+        expected = "\n".join(expected_lines)
 
         result = meth(card)
         assert result == expected
@@ -1227,7 +1227,7 @@ def test_with_metadata(self, card: Card, meth, expected_lines):
             "  metadata.foo={'bar': 123},",
             "  metadata.widget={...},",
         ]
-        expected = "".join(expected_lines[:2] + extra_lines + expected_lines[2:])
+        expected = "\n".join(expected_lines[:2] + extra_lines + expected_lines[2:])
 
         result = meth(card)
         assert result == expected
@@ -1251,7 +1251,7 @@ def test_model_card_repr(self, meth, suffix):
         card_from_path = self.path_to_card(file_name)
 
         result0 = meth(card_from_path)
-        expected = "Card(  model=LinearRegression(fit_intercept=False),"
+        expected = "Card(\n  model=LinearRegression(fit_intercept=False),"
         assert result0.startswith(expected)
 
         # change file name, same card should show different result
@@ -1259,7 +1259,7 @@ def test_model_card_repr(self, meth, suffix):
         file_handle, file_name = save_model_to_file(model, suffix)
         card_from_path.model = file_name
         result1 = meth(card_from_path)
-        expected = "Card(  model=LinearRegression(),"
+        expected = "Card(\n  model=LinearRegression(),"
         assert result1.startswith(expected)
 
         # change model on disk but keep same file name, should show different
@@ -1269,7 +1269,7 @@ def test_model_card_repr(self, meth, suffix):
             dump_fn = pickle.dump if suffix == ".pkl" else dump
             dump_fn(model, f)
         result2 = meth(card_from_path)
-        expected = "Card(  model=LinearRegression(fit_intercept=None),"
+        expected = "Card(\n  model=LinearRegression(fit_intercept=None),"
         assert result2.startswith(expected)
 
     @pytest.mark.parametrize("suffix", [".pkl", ".skops"])
@@ -1419,11 +1419,11 @@ class LineBreakInRepr:
             """Custom object whose repr has a line break"""
 
             def __repr__(self) -> str:
-                return "objwith lb"
+                return "obj\nwith lb"
 
         table_dict["with break"] = [
             LineBreakInRepr(),
-            "hithere",
+            "hi\nthere",
             """
 entry with
 line breaks
@@ -1520,13 +1520,13 @@ def card(self, template):
     def test_all_visible_by_default(self, card):
         rendered = card.render()
         expected = (
-            "# Model"
-            "Here goes model related stuff"
-            "## Metrics"
-            "123"
-            "## Bar"
-            "Baz"
-            "# Authors"
+            "# Model\n\n"
+            "Here goes model related stuff\n\n"
+            "## Metrics\n\n"
+            "123\n\n"
+            "## Bar\n\n"
+            "Baz\n\n"
+            "# Authors\n\n"
             "Jane Doe"
         )
         assert rendered.strip() == expected
@@ -1534,20 +1534,27 @@ def test_all_visible_by_default(self, card):
     def test_section_invisible(self, card):
         card.select("Model/Metrics").visible = False
         rendered = card.render()
-        expected = "# ModelHere goes model related stuff## BarBaz# AuthorsJane Doe"
+        expected = (
+            "# Model\n\n"
+            "Here goes model related stuff\n\n"
+            "## Bar\n\n"
+            "Baz\n\n"
+            "# Authors\n\n"
+            "Jane Doe"
+        )
         assert rendered.strip() == expected
 
     def test_restoring_visibility_works(self, card):
         card.select("Model/Metrics").visible = False
         card.select("Model/Metrics").visible = True
         expected = (
-            "# Model"
-            "Here goes model related stuff"
-            "## Metrics"
-            "123"
-            "## Bar"
-            "Baz"
-            "# Authors"
+            "# Model\n\n"
+            "Here goes model related stuff\n\n"
+            "## Metrics\n\n"
+            "123\n\n"
+            "## Bar\n\n"
+            "Baz\n\n"
+            "# Authors\n\n"
             "Jane Doe"
         )
         rendered = card.render()
@@ -1559,7 +1566,7 @@ def test_invisible_parent_section_hides_subsections(self, card):
         card.select("Model").visible = False
         # fmt: off
         expected = (
-            "# Authors"
+            "# Authors\n\n"
             "Jane Doe"
         )
         # fmt: on
@@ -1577,7 +1584,14 @@ def test_visibility_with_card_save(self, card):
         with open(file, "r") as f:
             loaded = f.read()
 
-        expected = "# ModelHere goes model related stuff## BarBaz# AuthorsJane Doe"
+        expected = (
+            "# Model\n\n"
+            "Here goes model related stuff\n\n"
+            "## Bar\n\n"
+            "Baz\n\n"
+            "# Authors\n\n"
+            "Jane Doe"
+        )
         assert loaded.strip() == expected
 
 
@@ -1586,43 +1600,19 @@ class TestCardTableOfContents:
     def card(self):
         model = LinearRegression()
         card = Card(model=model)
+        return card
+
+    def test_toc(self, card):
         card.add_model_plot()
         card.add_hyperparams()
         card.add_metrics(accuracy=0.1)
         card.add_get_started_code()
-        return card
-
-    def test_toc(self, card):
         toc = card.create_toc()
-        exptected_toc = [
-            "- Model description",
-            "  - Intended uses & limitations",
-            "  - Training Procedure",
-            "    - Hyperparameters",
-            "    - Model Plot",
-            "  - Evaluation Results",
-            "- How to Get Started with the Model",
-            "- Model Card Authors",
-            "- Model Card Contact",
-            "- Citation",
-        ]
-
-        assert toc == "\n".join(exptected_toc)
-
-    def test_toc_with_invisible_section(self, card):
-        section = card.select("Citation")
-        section.visible = False
-        toc = card.create_toc()
-        exptected_toc = [
-            "- Model description",
-            "  - Intended uses & limitations",
-            "  - Training Procedure",
-            "    - Hyperparameters",
-            "    - Model Plot",
-            "  - Evaluation Results",
-            "- How to Get Started with the Model",
-            "- Model Card Authors",
-            "- Model Card Contact",
-        ]
+        exptected_toc = (
+            "- Model description\n  - Intended uses & limitations\n  - Training"
+            " Procedure\n    - Hyperparameters\n    - Model Plot\n  - Evaluation"
+            " Results\n- How to Get Started with the Model\n- Model Card Authors\n-"
+            " Model Card Contact\n- Citation"
+        )
 
-        assert toc == "\n".join(exptected_toc)
+        assert toc == exptected_toc

From a82870417dfbb98090a800024f86a616adafca26 Mon Sep 17 00:00:00 2001
From: Thomas Lazarus <lazarustda@gmail.com>
Date: Wed, 1 Mar 2023 21:16:08 -0600
Subject: [PATCH 07/10] Fixes from find and replace

---
 skops/card/_model_card.py     |  2 +-
 skops/card/tests/test_card.py | 44 +++++++++++++++++++++++++++--------
 2 files changed, 35 insertions(+), 11 deletions(-)

diff --git a/skops/card/_model_card.py b/skops/card/_model_card.py
index e9356681..a68eb9d2 100644
--- a/skops/card/_model_card.py
+++ b/skops/card/_model_card.py
@@ -1321,6 +1321,7 @@ def _iterate_key_section_content(
         data: dict[str, Section],
         level: int = 0,
     ):
+        """Iterate through the key sections and yield the title and level."""
         for key, val in data.items():
             if not getattr(val, "visible", True):
                 continue
@@ -1337,7 +1338,6 @@ def _iterate_key_section_content(
     def create_toc(self) -> str:
         """Create a table of contents for the model card.
 
-
         Returns
         -------
         toc : str
diff --git a/skops/card/tests/test_card.py b/skops/card/tests/test_card.py
index 45c498e7..ea652ebf 100644
--- a/skops/card/tests/test_card.py
+++ b/skops/card/tests/test_card.py
@@ -1600,19 +1600,43 @@ class TestCardTableOfContents:
     def card(self):
         model = LinearRegression()
         card = Card(model=model)
-        return card
-
-    def test_toc(self, card):
         card.add_model_plot()
         card.add_hyperparams()
         card.add_metrics(accuracy=0.1)
         card.add_get_started_code()
+        return card
+
+    def test_toc(self, card):
         toc = card.create_toc()
-        exptected_toc = (
-            "- Model description\n  - Intended uses & limitations\n  - Training"
-            " Procedure\n    - Hyperparameters\n    - Model Plot\n  - Evaluation"
-            " Results\n- How to Get Started with the Model\n- Model Card Authors\n-"
-            " Model Card Contact\n- Citation"
-        )
+        exptected_toc = [
+            "- Model description",
+            "  - Intended uses & limitations",
+            "  - Training Procedure",
+            "    - Hyperparameters",
+            "    - Model Plot",
+            "  - Evaluation Results",
+            "- How to Get Started with the Model",
+            "- Model Card Authors",
+            "- Model Card Contact",
+            "- Citation",
+        ]
+
+        assert toc == "\n".join(exptected_toc)
+
+    def test_toc_with_invisible_section(self, card):
+        section = card.select("Citation")
+        section.visible = False
+        toc = card.create_toc()
+        exptected_toc = [
+            "- Model description",
+            "  - Intended uses & limitations",
+            "  - Training Procedure",
+            "    - Hyperparameters",
+            "    - Model Plot",
+            "  - Evaluation Results",
+            "- How to Get Started with the Model",
+            "- Model Card Authors",
+            "- Model Card Contact",
+        ]
 
-        assert toc == exptected_toc
+        assert toc == "\n".join(exptected_toc)

From f6ec0cc084c8550c1062bc03d4ca7ec914bbe553 Mon Sep 17 00:00:00 2001
From: Thomas Lazarus <lazarustda@gmail.com>
Date: Mon, 6 Mar 2023 18:57:33 -0600
Subject: [PATCH 08/10] Renames method and adds comments

---
 skops/card/_model_card.py     | 27 +++++++++++++++++++++++++--
 skops/card/tests/test_card.py |  4 ++--
 2 files changed, 27 insertions(+), 4 deletions(-)

diff --git a/skops/card/_model_card.py b/skops/card/_model_card.py
index a68eb9d2..2724bc52 100644
--- a/skops/card/_model_card.py
+++ b/skops/card/_model_card.py
@@ -1321,7 +1321,30 @@ def _iterate_key_section_content(
         data: dict[str, Section],
         level: int = 0,
     ):
-        """Iterate through the key sections and yield the title and level."""
+        """Iterate through the key sections and yield the title and level.
+
+        Parameters
+        ----------
+        data : dict[str, Section]
+            The card data to iterate through. This is usually the sections and subsections.
+
+        level : int, optional
+            The level of the section, by default 0. This keeps track of subsections.
+
+        Returns
+        -------
+        table_of_contents : str
+            Example:
+                - Model description
+                    - Intended uses & limitations
+                    - Training Procedure
+                        - Hyperparameters
+                        - Model Plot
+                    - Evaluation Results
+                - How to Get Started with the Model
+                - Model Card Authors
+                - Model Card Contact
+        """
         for key, val in data.items():
             if not getattr(val, "visible", True):
                 continue
@@ -1335,7 +1358,7 @@ def _iterate_key_section_content(
                     level=level + 1,
                 )
 
-    def create_toc(self) -> str:
+    def get_toc(self) -> str:
         """Create a table of contents for the model card.
 
         Returns
diff --git a/skops/card/tests/test_card.py b/skops/card/tests/test_card.py
index ea652ebf..965cf918 100644
--- a/skops/card/tests/test_card.py
+++ b/skops/card/tests/test_card.py
@@ -1607,7 +1607,7 @@ def card(self):
         return card
 
     def test_toc(self, card):
-        toc = card.create_toc()
+        toc = card.get_toc()
         exptected_toc = [
             "- Model description",
             "  - Intended uses & limitations",
@@ -1626,7 +1626,7 @@ def test_toc(self, card):
     def test_toc_with_invisible_section(self, card):
         section = card.select("Citation")
         section.visible = False
-        toc = card.create_toc()
+        toc = card.get_toc()
         exptected_toc = [
             "- Model description",
             "  - Intended uses & limitations",

From 3d07ae347467fc005a46332d7dfe4e3fc5339ba8 Mon Sep 17 00:00:00 2001
From: Thomas Lazarus <lazarustda@gmail.com>
Date: Fri, 10 Mar 2023 18:06:26 -0600
Subject: [PATCH 09/10] Cleans up the comments

---
 skops/card/_model_card.py | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/skops/card/_model_card.py b/skops/card/_model_card.py
index 2724bc52..bd6d2a51 100644
--- a/skops/card/_model_card.py
+++ b/skops/card/_model_card.py
@@ -1334,16 +1334,6 @@ def _iterate_key_section_content(
         Returns
         -------
         table_of_contents : str
-            Example:
-                - Model description
-                    - Intended uses & limitations
-                    - Training Procedure
-                        - Hyperparameters
-                        - Model Plot
-                    - Evaluation Results
-                - How to Get Started with the Model
-                - Model Card Authors
-                - Model Card Contact
         """
         for key, val in data.items():
             if not getattr(val, "visible", True):
@@ -1359,12 +1349,22 @@ def _iterate_key_section_content(
                 )
 
     def get_toc(self) -> str:
-        """Create a table of contents for the model card.
+        """Get the table of contents for the model card.
 
         Returns
         -------
         toc : str
             The table of contents for the model card formatted as a markdown string.
+            Example:
+                - Model description
+                    - Intended uses & limitations
+                    - Training Procedure
+                        - Hyperparameters
+                        - Model Plot
+                    - Evaluation Results
+                - How to Get Started with the Model
+                - Model Card Authors
+                - Model Card Contact
         """
         sections = []
         for title, level in self._iterate_key_section_content(self._data):

From 2a2384456358023dc89d45d9173714f109399f24 Mon Sep 17 00:00:00 2001
From: Thomas Lazarus <lazarustda@gmail.com>
Date: Fri, 10 Mar 2023 18:13:07 -0600
Subject: [PATCH 10/10] Fixes linter

---
 skops/card/tests/test_card.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/skops/card/tests/test_card.py b/skops/card/tests/test_card.py
index 53ffa667..fb7e331b 100644
--- a/skops/card/tests/test_card.py
+++ b/skops/card/tests/test_card.py
@@ -1777,7 +1777,7 @@ def test_metric_table_with_description(self, card: Card, metric_frame):
             " |\n|              0.4 |\n|              0.5 |\n\n</details>"
         )
         assert expected_table == actual_table
-       
+
 
 class TestCardTableOfContents:
     @pytest.fixture