chore: refine description wording

tidbcloud · Jun 29, 2024 · 670cc59 · 670cc59
1 parent 6b61ac9
commit 670cc59
Show file tree

Hide file tree

Showing 11 changed files with 12 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -29,12 +29,12 @@ https://github.com/tidbcloud/tisqleditor/assets/1284531/732b600f-5b4e-45d3-a3d2-
 | @tidbcloud/codemirror-extension-sql-parser       | parse the editor content to SQL statements                                |
 | @tidbcloud/codemirror-extension-cur-sql          | get the selected SQL statements                                           |
 | @tidbcloud/codemirror-extension-cur-sql-gutter   | show gutter for the selected SQL statements                               |
-| @tidbcloud/codemirror-extension-sql-autocomplete | SQL keyword and database schema autocomplete tips                         |
+| @tidbcloud/codemirror-extension-sql-autocomplete | SQL keyword and database schema autocomplete                              |
 | @tidbcloud/codemirror-extension-linters          | use db statement, full width chars, and regular expression linters        |
 | @tidbcloud/codemirror-extension-save-helper      | save the editor content if it changes                                     |
 | @tidbcloud/codemirror-extension-events           | 2 normal kinds of event listener: doc change, selection change            |
 | @tidbcloud/codemirror-extension-themes           | 2 simple builtin themes, `bbedit` for light mode, `oneDark` for dark mode |
-| @tidbcloud/codemirror-extension-basic-setup      | basic configuration for the CodeMirror6 code editor                       |
+| @tidbcloud/codemirror-extension-basic-setup      | basic configuration for codemirror                                        |
 
 ## Usage
 

diff --git a/packages/extensions/ai-widget/README.md b/packages/extensions/ai-widget/README.md
@@ -1,6 +1,6 @@
 # @tidbcloud/codemirror-extension-ai-widget
 
-This extension provides a widget to chat with AI to help you write or refine SQL. (work with other languages wip)
+A codemirror extension provides a widget to chat with AI to help you write or refine SQL. (work with other languages wip)
 
 https://github.com/tidbcloud/tisqleditor/assets/1284531/46684333-7efa-4925-bf58-9ab3fb45f692
 

diff --git a/packages/extensions/basic-setup/README.md b/packages/extensions/basic-setup/README.md
@@ -1,6 +1,6 @@
 # @tidbcloud/codemirror-extension-basic-setup
 
-Default basic configuration for the CodeMirror6 code editor.
+Default basic configuration for codemirror.
 
 ## Installation
 

diff --git a/packages/extensions/cur-sql-gutter/README.md b/packages/extensions/cur-sql-gutter/README.md
@@ -1,6 +1,6 @@
 # @tidbcloud/codemirror-extension-cur-sql-gutter
 
-This extension listens the editor selection change, and shows gutter for the SQL statements around the cursor position to make it highlight.
+A codemirror extension listens the editor selection change, and shows gutter for the SQL statements around the cursor position to make it highlight.
 
 ## Try it
 

diff --git a/packages/extensions/cur-sql/README.md b/packages/extensions/cur-sql/README.md
@@ -1,6 +1,6 @@
 # @tidbcloud/codemirror-extension-cur-sql
 
-This extension listens the editor selection change, return the complete SQL statements around the cursor position.
+A codemirror extension listens the editor selection change, returns the complete SQL statements around the cursor position.
 
 This extension is installed internally inside the `SQLEditorInstance`.
 

diff --git a/packages/extensions/events/README.md b/packages/extensions/events/README.md
@@ -1,6 +1,6 @@
 # @tidbcloud/codemirror-extension-events
 
-2 normal kinds of event listener: doc change, selection change
+2 normal kinds of codemirror event listener: doc change, selection change
 
 - onDocChange: triggered when doc changes
 - onSelectionChange: triggered when selection changes

diff --git a/packages/extensions/linters/README.md b/packages/extensions/linters/README.md
@@ -1,6 +1,6 @@
 # @tidbcloud/codemirror-extension-linters
 
-This extension provides 3 linters:
+3 linter codemirror extensions:
 
 - useDbLinter: use statement linter, the first statement should be `use ${dbName};`
 - fullWidthCharLinter: lint all the full width characters

diff --git a/packages/extensions/save-helper/README.md b/packages/extensions/save-helper/README.md
@@ -1,6 +1,6 @@
 # @tidbcloud/codemirror-extension-save-helper
 
-This extension listens the editor doc changes, if changes, it will call the save handler in delay time, or, you can press the defined hotkey (default is `Mod-s`) to call save handler immediately.
+A codemirror extension listens the editor doc changes, if changes, it will call the save handler in delay time, or, you can press the defined hotkey (default is `Mod-s`) to call save handler immediately.
 
 ## Try it
 

diff --git a/packages/extensions/sql-autocomplete/README.md b/packages/extensions/sql-autocomplete/README.md
@@ -1,6 +1,6 @@
 # @tidbcloud/codemirror-extension-sql-autocomplete
 
-This extension implements the SQL keyword and database schema autocompletion based `@codemirror/autocomplete` for the CodeMirror6 editor, with a customized style.
+A codemirror extension implements the SQL keyword and database schema autocompletion based `@codemirror/autocomplete`, with a customized style.
 
 ## Try it
 

diff --git a/packages/extensions/sql-parser/README.md b/packages/extensions/sql-parser/README.md
@@ -1,6 +1,6 @@
 # @tidbcloud/codemirror-extension-sql-parser
 
-This extension listens the editor doc change, return all the parsed statements.
+A codemirror extension listens the editor doc change, parses the content to SQL statements.
 
 This extension is installed internally inside the `SQLEditorInstance`.
 

diff --git a/packages/extensions/themes/README.md b/packages/extensions/themes/README.md
@@ -1,6 +1,6 @@
 # @tidbcloud/codemirror-extension-themes
 
-This extension provides 2 simple and out of box editor themes to use, `bbedit` is for light mode and `oneDark` is for dark mode.
+Codemirror theme extensions, provide 2 simple and out of box editor themes to use, `bbedit` is for light mode and `oneDark` is for dark mode.
 
 If these 2 themes are not suitable for you, you can choose other themes from third-party libraries or customized a theme by yourself.