Changed notebook example.

souradipp76 · Jan 4, 2025 · d151ed1 · d151ed1
1 parent e4d39a6
commit d151ed1
Showing 1 changed file with 2 additions and 5 deletions.
diff --git a/examples/example.ipynb b/examples/example.ipynb
@@ -98,7 +98,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "## Generate README of the sample repository"
+        "## Generate README for the sample repository"
       ]
     },
     {
@@ -114,9 +114,6 @@
       },
       "outputs": [],
       "source": [
-        "\"\"\"\n",
-        "Example\n",
-        "\"\"\"\n",
         "from readme_ready.query import query\n",
         "from readme_ready.index import index\n",
         "from readme_ready.types import (\n",
@@ -178,7 +175,7 @@
         "\n",
         "readme_config = AutodocReadmeConfig(\n",
         "    # Set comma separated list of README headings\n",
-        "    headings = \"Description\"\n",
+        "    headings = \"Description,Requirements,Installation,Usage,Contributing,License\"\n",
         ")\n",
         "\n",
         "index.index(repo_config)\n",