Skip to content

Commit 7dc7b86

Browse files
committed
fix(docs): repair invalid JSON in cli.ipynb table cell
The CLI command-table cell contained raw newline characters inside JSON string literals (e.g. "| Command | Purpose |<LF>",) which is invalid JSON. nbformat / nbval failed to parse the notebook, breaking the docs and notebook test jobs: nbformat.reader.NotJSONError: Notebook does not appear to be JSON Invalid control character at: line 44 column 27 Replace the embedded newlines with the proper \n escape so each markdown table row is a valid JSON string. nbval now collects the notebook (13 cells) and make docs-build succeeds.
1 parent 9b739c6 commit 7dc7b86

1 file changed

Lines changed: 15 additions & 30 deletions

File tree

docs/user_guide/cli.ipynb

Lines changed: 15 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -41,36 +41,21 @@
4141
"## Commands\n",
4242
"The table below documents the current CLI tree. Use ``rvl index --help`` and ``rvl stats --help`` for detailed flag help and examples.\n",
4343
"\n",
44-
"| Command | Purpose |
45-
",
46-
"|---------|---------|
47-
",
48-
"| `rvl version` | display the installed RedisVL version |
49-
",
50-
"| `rvl index create` | create a new Redis search index from a schema YAML file |
51-
",
52-
"| `rvl index info` | display schema and storage details for an index |
53-
",
54-
"| `rvl index listall` | list Redis search indexes available on the target Redis deployment |
55-
",
56-
"| `rvl index delete` | delete an index while leaving indexed data in Redis |
57-
",
58-
"| `rvl index destroy` | delete an index and drop its indexed data |
59-
",
60-
"| `rvl stats` | display statistics for an existing Redis search index |
61-
",
62-
"| `rvl mcp` | run the RedisVL MCP server |
63-
",
64-
"| `rvl migrate wizard` | interactively build a migration plan and schema patch (experimental) |
65-
",
66-
"| `rvl migrate plan` | generate `migration_plan.yaml` from a patch or target schema (experimental) |
67-
",
68-
"| `rvl migrate apply` | execute a reviewed `drop_recreate` migration (experimental) |
69-
",
70-
"| `rvl migrate validate` | validate a completed migration and emit report artifacts (experimental) |
71-
",
72-
"
73-
",
44+
"| Command | Purpose |\n",
45+
"|---------|---------|\n",
46+
"| `rvl version` | display the installed RedisVL version |\n",
47+
"| `rvl index create` | create a new Redis search index from a schema YAML file |\n",
48+
"| `rvl index info` | display schema and storage details for an index |\n",
49+
"| `rvl index listall` | list Redis search indexes available on the target Redis deployment |\n",
50+
"| `rvl index delete` | delete an index while leaving indexed data in Redis |\n",
51+
"| `rvl index destroy` | delete an index and drop its indexed data |\n",
52+
"| `rvl stats` | display statistics for an existing Redis search index |\n",
53+
"| `rvl mcp` | run the RedisVL MCP server |\n",
54+
"| `rvl migrate wizard` | interactively build a migration plan and schema patch (experimental) |\n",
55+
"| `rvl migrate plan` | generate `migration_plan.yaml` from a patch or target schema (experimental) |\n",
56+
"| `rvl migrate apply` | execute a reviewed `drop_recreate` migration (experimental) |\n",
57+
"| `rvl migrate validate` | validate a completed migration and emit report artifacts (experimental) |\n",
58+
"\n",
7459
"Within data-plane commands, ``-i`` or ``--index`` targets an existing Redis index name and ``-s`` or ``--schema`` points to a schema YAML file. Shared Redis connection options such as ``--url``, ``--host``, and ``--port`` apply to ``rvl index`` and ``rvl stats``."
7560
]
7661
},

0 commit comments

Comments
 (0)