Skip to content

Commit edfa667

Browse files
committed
Update README.md
Fixed the description of the format to be applied
1 parent bacfdd3 commit edfa667

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Checks that bind variables are used appropriately for DAO and SQL associations.
3434
The plugin also provides quick fixes for DAO methods where the required SQL files do not exist.
3535

3636
- Quick fix to generate SQL template file.
37+
3738
![quickfix.png](images/quickfix.png)
3839
- Checks for unused DAO method arguments.
3940
![inspection.png](images/inspection.png)
@@ -73,16 +74,16 @@ Along with DAO changes, the plugin will refactor the SQL file directory and file
7374
Provides code formatting for SQL syntax.
7475
This feature is in preview. You cannot customize the indentation or keywords to be broken down!
7576

76-
The formatter works with both SQL files and SQL text blocks within `@Sql` annotations in DAO methods.
77+
The formatting applies to SQL written in SQL files and in value fields (text blocks) within org.seasar.doma.Sql annotations.
78+
79+
![Format.gif](images/gif/Format.gif)
7780

7881
Automatic indentation on newlines provided by the SQL formatting feature is disabled by default.
7982

8083
To enable auto-indentation, toggle the corresponding flag in the settings screen below.
8184

8285
`Settings > Other Settings > Doma Tools > Enable auto-indent for SQL`
8386

84-
![Format.gif](images/gif/Format.gif)
85-
8687
### Limitations
8788
The current formatter has the following limitations:
8889

0 commit comments

Comments
 (0)