Skip to content

Commit 76f9a28

Browse files
committed
README update
1 parent 10909d1 commit 76f9a28

File tree

1 file changed

+10
-18
lines changed

1 file changed

+10
-18
lines changed

README.md

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,7 @@
3636
- [Install from GitHub](#install-from-github)
3737
- [Workspace](#workspace)
3838
- [Commands](#commands)
39-
- [Own ObjectScript Create](#own-objectscript-create)
40-
- [Own ObjectScript Modifier](#own-objectscript-modifier)
41-
- [Own ObjectScript Comment](#own-objectscript-comment)
42-
- [Own ObjectScript SQL](#own-objectscript-sql)
43-
- [Own ObjectScript Translate](#own-objectscript-translate)
4439
- [Configuration](#configuration)
45-
- [Sql](#sql)
46-
- [Comment](#comment)
47-
- [Create](#create)
4840
- [Color Theme](#color-theme)
4941
- [Bugs](#bugs)
5042
- [Release Notes](#release-notes)
@@ -63,7 +55,7 @@ This command automatically adds `Set`, `Do` and `Write` to your InterSystems Obj
6355

6456
### `Add Method Description`
6557

66-
Generates description templates for your method. Just put your cursor in the method and execute this command. Only works with `Method` and `ClassMethod`.
58+
Writing comprehensive method descriptions is essential for maintaining code clarity and promoting collaboration. Simply place your cursor within a method and execute the `Add Method Description` command. The command will automatically generate a description template for the method, making it easy to provide meaningful documentation.
6759

6860
![demoAddDescription](https://github.com/phil1436/ownobjectscriptextension/raw/master/resources/demoAddDescription.gif)
6961

@@ -73,27 +65,27 @@ Generates description templates for your method. Just put your cursor in the met
7365
7466
### `Make Select Statement`
7567

76-
Generates a _SELECT_ statement based on the currently opened file.
68+
When working with ObjectScript, you often need to interact with databases. The `Make Select Statement` feature simplifies the process of generating SQL _SELECT_ statements. By analyzing the currently opened ObjectScript file, the extension creates a _SELECT_ statement based on the class name.
7769

7870
![demoMakeSelectStatement](https://github.com/phil1436/ownobjectscriptextension/raw/master/resources/DemoMakeSelectStatement.gif)
7971

80-
> Tip: Install the [SQLTools](https://github.com/mtxr/vscode-sqltools) extension to execute the statement directly in VSCode.
72+
> Tip: Install the [SQLTools](https://github.com/mtxr/vscode-sqltools) extension to execute the statement directly within Visual Studio Code.
8173
8274
### `Create New Wizard` _BETA_
8375

84-
Creates a new ObjectScript Class, Message, Business Service or Business Operation similar to the InterSystems Studio Wizard. Just execute the command and follow the instructions.
76+
Creating new ObjectScript classes, messages, business services, or business operations is made more convenient with the `Create New Wizard` feature. This wizard-like interface guides you through the process of generating new components, resembling the familiar InterSystems Studio Wizard. By executing the command and following the instructions, you can quickly set up new ObjectScript artifacts, saving you time and effort.
8577

8678
![DemoCreateNewClass](https://raw.githubusercontent.com/phil1436/ownobjectscriptextension/master/resources/DemoCreateNewClass.gif)
8779

88-
> This feature is still in beta.
80+
> This feature is currently in beta and may not work as expected. You may have to adjust the generated code.
8981
9082
### `Translate Embedded Python` _BETA_
9183

92-
Translate an ObjectScript method to embedded python. Will generate a new method with the same name and the prefix _py_.
84+
In certain scenarios, you may want to leverage the power of Python within your ObjectScript code. The `Translate Embedded Python` feature allows you to translate ObjectScript methods to embedded Python methods. By executing the command, the extension generates a new method with the same name, prefixed with _py_. This enables you to incorporate Python functionality while maintaining the structure and organization of your codebase.
9385

9486
![demoTranslateEmbeddedPython](https://github.com/phil1436/ownobjectscriptextension/raw/master/resources/demoTranslateEmbeddedPython.gif)
9587

96-
> This feature is still in beta.
88+
> This feature is currently in beta and may not work as expected. You may have to adjust the generated code.
9789
9890
---
9991

@@ -150,12 +142,12 @@ This extension will create a directory named _ownobjectscriptextension-workspace
150142
### Own ObjectScript Comment
151143

152144
- `Add Method Description`: Adds a description template to your `Method` or `ClassMethod`. See [here](#add-method-description) for more information.
145+
- `Edit Method Description Template`: Opens the _MethodDescriptionTemplate.json_ file so you can edit the method template. Reload Window after editing!
153146
- `Add Inline Comments`: Adds a comment in the current Method every specified count of lines without any comment (Default is every 5 lines).
154-
- `Edit Method Description Template`: Opens the _MethodDescriptionTemplate.json_ file so can edit the method template. Reload Window after editing.
155147

156148
### Own ObjectScript SQL
157149

158-
- `Make Select Statement`: Copies a SQL-Select-Statement based on the currently opened file to the clipboard. If _OpenSQLFile_ is enabled a sql file will be generated.
150+
- `Make Select Statement`: Copies a SQL-Select-Statement based on the currently opened file to the clipboard. If the configuration _OpenSQLFile_ is enabled a sql file will be generated.
159151

160152
### Own ObjectScript Translate
161153

@@ -167,7 +159,7 @@ This extension will create a directory named _ownobjectscriptextension-workspace
167159

168160
Go to `File > Preferences > Settings` and than navigate to `Extensions > OwnObjectscriptExtension`.
169161

170-
- `Save File`: Set if the current opend file will be saved after a command (Default: _disabled_).
162+
- `Save File`: Set if the current opened file will be saved after a command (Default: _disabled_).
171163
- `Show Messages`: Set if the extension will show information messages (Default: _enabled_).
172164

173165
### Sql

0 commit comments

Comments
 (0)