Skip to content

Commit d151ed1

Browse files
committed
Changed notebook example.
1 parent e4d39a6 commit d151ed1

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

examples/example.ipynb

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
"cell_type": "markdown",
9999
"metadata": {},
100100
"source": [
101-
"## Generate README of the sample repository"
101+
"## Generate README for the sample repository"
102102
]
103103
},
104104
{
@@ -114,9 +114,6 @@
114114
},
115115
"outputs": [],
116116
"source": [
117-
"\"\"\"\n",
118-
"Example\n",
119-
"\"\"\"\n",
120117
"from readme_ready.query import query\n",
121118
"from readme_ready.index import index\n",
122119
"from readme_ready.types import (\n",
@@ -178,7 +175,7 @@
178175
"\n",
179176
"readme_config = AutodocReadmeConfig(\n",
180177
" # Set comma separated list of README headings\n",
181-
" headings = \"Description\"\n",
178+
" headings = \"Description,Requirements,Installation,Usage,Contributing,License\"\n",
182179
")\n",
183180
"\n",
184181
"index.index(repo_config)\n",

0 commit comments

Comments
 (0)