Skip to content

Commit bf6240b

Browse files
tobytwiggertobytwigger-swytch
authored andcommitted
Clarify use of --reset and --smart-reset flags in documentation (barryvdh#1494)
* Update README.md Clarified model behaviour when using the --reset option * Add --smart-reset to the documentation --------- Co-authored-by: Toby Twigger <[email protected]>
1 parent aa95dc6 commit bf6240b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,9 +145,9 @@ The class name will be different from the model, avoiding the IDE duplicate anno
145145

146146
> Please make sure to back up your models, before writing the info.
147147
148-
Writing to the models should keep the existing comments and only append new properties/methods.
149-
The existing PHPDoc is replaced, or added if not found.
150-
With the `--reset (-R)` option, the existing PHPDocs are ignored, and only the newly found columns/relations are saved as PHPDocs.
148+
Writing to the models should keep the existing comments and only append new properties/methods. It will not update changed properties/methods.
149+
150+
With the `--reset (-R)` option, the whole existing PHPDoc is replaced, including any comments that have been made. The `--smart-reset` option will instead keep the 'text' part of the phpdoc comment, and just replace all the property/method defininitions.
151151

152152
```bash
153153
php artisan ide-helper:models "App\Models\Post"

0 commit comments

Comments
 (0)