Skip to content

Conversation

@shatakshiiii
Copy link
Contributor

Related: #3624

@shatakshiiii shatakshiiii self-assigned this Sep 29, 2023
@shatakshiiii shatakshiiii temporarily deployed to ack September 29, 2023 06:39 — with GitHub Actions Inactive
@shatakshiiii shatakshiiii temporarily deployed to ack September 29, 2023 06:39 — with GitHub Actions Inactive
@shatakshiiii shatakshiiii marked this pull request as ready for review September 29, 2023 06:53
@shatakshiiii shatakshiiii requested a review from a team as a code owner September 29, 2023 06:53
Copy link
Member

@ssbarnea ssbarnea left a comment

Choose a reason for hiding this comment

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

My view on this is that we do not need to flood the user with extra examples for the auto-fix when the change is obvious and matches our already existing examples in rule documentation.

I looked at the produced documentation page and I seen it becoming long enough to detect many people from reading it.

I personally think that it was enough to mention that this rule can be automatically fixed in a paragraph inside the correct example section.

@ganeshrn WDYT about this?

@ganeshrn
Copy link
Member

My view on this is that we do not need to flood the user with extra examples for the auto-fix when the change is obvious and matches our already existing examples in rule documentation.

I looked at the produced documentation page and I seen it becoming long enough to detect many people from reading it.

I personally think that it was enough to mention that this rule can be automatically fixed in a paragraph inside the correct example section.

@ganeshrn WDYT about this?

Yup a visible mention that the rule supports autofix will be good enough.

@cidrblock cidrblock self-requested a review September 29, 2023 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants