-
-
Notifications
You must be signed in to change notification settings - Fork 6.9k
Fix @var tags syntax in docs #20391
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix @var tags syntax in docs #20391
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #20391 +/- ##
=========================================
Coverage 64.43% 64.43%
Complexity 11446 11446
=========================================
Files 433 433
Lines 37457 37457
=========================================
Hits 24137 24137
Misses 13320 13320 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
docs/guide-es/structure-views.md
Outdated
/** @var yii\web\View $this */ | ||
/** @var yii\widgets\ActiveForm $form */ | ||
/** @var app\models\LoginForm $model */ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/** @var yii\web\View $this */ | |
/** @var yii\widgets\ActiveForm $form */ | |
/** @var app\models\LoginForm $model */ | |
/** | |
* @var \yii\web\View $this | |
* @var \yii\widgets\ActiveForm $form | |
* @var \app\models\LoginForm $model | |
*/ |
I'd also make it shorter
/** @var yii\web\View $this */ | |
/** @var yii\widgets\ActiveForm $form */ | |
/** @var app\models\LoginForm $model */ | |
/** use section */ | |
/** | |
* @var View $this | |
* @var ActiveForm $form | |
* @var LoginForm $model | |
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed it. Thanks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about short aliases?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please also do these steps in the #20392?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that there is no uniform code style in the templates and in the framework itself. In my opinion, it's worth bringing everything to a single format. But it's better to do it separately, because that's not the purpose of my pull request.
If we're not talking in the context of this pull request, then I think it's a good idea.
Thank you! |
https://docs.phpdoc.org/guide/references/phpdoc/tags/var.html