Skip to content
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

Improve rules configuration docs #2511

Open
tigitz opened this issue Aug 13, 2024 · 0 comments
Open

Improve rules configuration docs #2511

tigitz opened this issue Aug 13, 2024 · 0 comments

Comments

@tigitz
Copy link
Contributor

tigitz commented Aug 13, 2024

Hello,

I've noticed that the current documentation for Rector rules only shows the configuration setup, but it doesn't explain the purpose of the configuration values. This forces me to open the rule directly in my IDE to understand the details.

For example, this page: https://getrector.com/rule-detail/class-property-assign-to-constructor-promotion-rector

It might be useful to automatically parse the relevant information from the Rule file and inject it into the documentation. Could improve DX, especially during project setup.

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

No branches or pull requests

1 participant