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

Warn on cabal format invocation #10549

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jasagredo
Copy link
Collaborator

@jasagredo jasagredo commented Nov 12, 2024

Just adding a warning seems like a good enough solution for now as we don't seem to want to deprecate the command. I think this doesn't deserve a changelog or update to the docs.


Template Α: This PR modifies behaviour or interface

Include the following checklist in your PR:

Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

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

this doesn't deserve a changelog or update to the docs.

I disagree. If our goal is to inform users, these are effective tools to do that.

@jasagredo
Copy link
Collaborator Author

I will add the changelog but I disagree. We shouldn't swamp ourselves in bureaucracy. This PR just emits a warning, it is extremely minimal.

@ulysses4ever
Copy link
Collaborator

This PR is small, but that's not the point. The point is that it's only logical to use release notes (and probably docs) to convey that cabal format is barely usable.

@jasagredo
Copy link
Collaborator Author

jasagredo commented Nov 14, 2024

Let me know if the changelog entry looks good to you @ulysses4ever. In particular I don't think this is significant.

About documentation, the command is not mentioned in the documentation and for now I think that is OK. We don't want to give it more visibility than necessary, I think.

@jasagredo jasagredo mentioned this pull request Nov 14, 2024
5 tasks
@ulysses4ever
Copy link
Collaborator

Brilliant, thank you!

@jasagredo jasagredo added merge me Tell Mergify Bot to merge and removed attention: needs-review labels Nov 14, 2024
@mergify mergify bot added the ready and waiting Mergify is waiting out the cooldown period label Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge me Tell Mergify Bot to merge ready and waiting Mergify is waiting out the cooldown period
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants