-
Notifications
You must be signed in to change notification settings - Fork 697
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
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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.
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. |
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 |
9b093d2
to
82e655a
Compare
Let me know if the changelog entry looks good to you @ulysses4ever. In particular I don't think this is 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. |
Brilliant, thank you! |
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:
significance: significant
in the changelog file.The documentation has been updated, if necessary.Manual QA notes have been included.Tests have been added. (Ask for help if you don’t know how to write them! Ask for an exemption if tests are too complex for too little coverage!)