Skip to content

dev: improve deprecated comments #5141

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

Closed

Conversation

alexandear
Copy link
Member

No description provided.

@alexandear alexandear added the topic: cosmetic changes contain cosmetic improvements label Nov 18, 2024
@ldez ldez added declined and removed topic: cosmetic changes contain cosmetic improvements labels Nov 18, 2024
@ldez
Copy link
Member

ldez commented Nov 18, 2024

This deprecation is a bit special, and not handled in this way.

@ldez ldez closed this Nov 18, 2024
@bombsimon
Copy link
Member

Wasn't this change just to clarify why it's deprecated/what to use instead to avoid tribal knowledge rather than some process or parsing? At least for me it's better to add some context to deprecation comments even if just for developers.

@ldez
Copy link
Member

ldez commented Nov 18, 2024

The problem is that the comment is wrong: the GitHub action format is not replaced by another.

@bombsimon
Copy link
Member

Ah, I see, I misinterpreted your comment! Then it makes a lot more sense to not merge this!

@alexandear
Copy link
Member Author

The problem is that the comment is wrong: the GitHub action format is not replaced by another.

We can add the link to the comment with explanation:

// Deprecated: not needed, see https://github.com/golangci/golangci-lint/issues/4695#issuecomment-2097087189

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

Successfully merging this pull request may close these issues.

3 participants