You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -63,7 +55,7 @@ This command automatically adds `Set`, `Do` and `Write` to your InterSystems Obj
63
55
64
56
### `Add Method Description`
65
57
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.
@@ -73,27 +65,27 @@ Generates description templates for your method. Just put your cursor in the met
73
65
74
66
### `Make Select Statement`
75
67
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.
> 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.
81
73
82
74
### `Create New Wizard`_BETA_
83
75
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.
> This feature is currently in beta and may not work as expected. You may have to adjust the generated code.
89
81
90
82
### `Translate Embedded Python`_BETA_
91
83
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.
> This feature is currently in beta and may not work as expected. You may have to adjust the generated code.
97
89
98
90
---
99
91
@@ -150,12 +142,12 @@ This extension will create a directory named _ownobjectscriptextension-workspace
150
142
### Own ObjectScript Comment
151
143
152
144
-`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!
153
146
-`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.
155
147
156
148
### Own ObjectScript SQL
157
149
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.
159
151
160
152
### Own ObjectScript Translate
161
153
@@ -167,7 +159,7 @@ This extension will create a directory named _ownobjectscriptextension-workspace
167
159
168
160
Go to `File > Preferences > Settings` and than navigate to `Extensions > OwnObjectscriptExtension`.
169
161
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_).
171
163
-`Show Messages`: Set if the extension will show information messages (Default: _enabled_).
0 commit comments