Skip to content

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

Merged
merged 3 commits into from
Jun 3, 2025
Merged

Conversation

max-s-lab
Copy link
Contributor

@max-s-lab max-s-lab commented May 31, 2025

Q A
Is bugfix?
New feature?
Breaks BC?
Fixed issues

https://docs.phpdoc.org/guide/references/phpdoc/tags/var.html

Copy link

codecov bot commented May 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.43%. Comparing base (cde0596) to head (b85ea1a).
Report is 2 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment on lines 23 to 25
/** @var yii\web\View $this */
/** @var yii\widgets\ActiveForm $form */
/** @var app\models\LoginForm $model */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/** @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

Suggested change
/** @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
*/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed it. Thanks

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about short aliases?

Copy link
Member

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?

Copy link
Contributor Author

@max-s-lab max-s-lab Jun 3, 2025

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.

image

image

image

image

@max-s-lab max-s-lab requested a review from xepozz June 3, 2025 09:55
@samdark samdark merged commit 943da8c into yiisoft:master Jun 3, 2025
86 checks passed
@samdark
Copy link
Member

samdark commented Jun 3, 2025

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants