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.

Sign up for GitHub

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

Jump to bottom

Inconsistency in short / full description between properties and methods #244

Open

arogachev opened this issue Dec 6, 2021 · 0 comments

Assignees

Labels

status:under discussion type:bug

Milestone

Contributor

arogachev commented Dec 6, 2021 •

edited

Loading

What steps will reproduce the problem?

In properties full description contains short description, while in methods does not.

https://www.yiiframework.com/doc/api/2.0/yii-base-controller#$defaultAction-detail (the short description is not rendered here at all).
https://www.yiiframework.com/doc/api/2.0/yii-base-controller#actions()-detail (the short description is rendered as bold text).

What's expected?

Consistency.

What do you get instead?

Inconsistency.

Additional info

Q	A
Yii vesion	doesn't matter
Yii APIDoc version	master
PHP version	doesn't matter
Operating system	doesn't matter

Should also check constants etc.

arogachev added type:bug status:under discussion labels

arogachev self-assigned this

arogachev added this to the 3.1.0 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment