'XMonad.Actions.MessageFeedback': standardize #261
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Follow the naming conventions of `XMonad.Operations`. Functions returning `X ()` are named regularly (previously these ended in underscore) while those returning `X Bool` are suffixed with an uppercase 'B'. - Provide all `X Bool` and `SomeMessage` variations for `sendMessage` and `sendMessageWithNoRefresh`, not just `sendMessageWithNoRefreshToCurrent` (renamed from `send`). - The new `tryInOrderB` and `tryMessageB` functions accept a parameter of type `SomeMessage -> X Bool`, which means you are no longer constrained to the behavior of the `sendMessageWithNoRefreshToCurrent` dispatcher. - The `send*Messages*` family of funtions allows for sequencing arbitrary sets of messages with minimal refresh. It makes little sense for these functions to support custom message dispatchers. - Remain backwards compatible. Maintain deprecated aliases of all renamed functions: - `send` -> `sendMessageWithNoRefreshToCurrentB` - `sendSM` -> `sendSomeMessageWithNoRefreshToCurrentB` - `sendSM_` -> `sendSomeMessageWithNoRefreshToCurrent` - `tryInOrder` -> `tryInOrderWithNoRefreshToCurrentB` - `tryInOrder_` -> `tryInOrderWithNoRefreshToCurrent` - `tryMessage` -> `tryMessageWithNoRefreshToCurrentB` - `tryMessage_` -> `tryMessageWithNoRefreshToCurrent`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow the naming conventions of
XMonad.Operations. Functions returningX ()are named regularly (previously these ended in underscore) whilethose returning
X Boolare suffixed with an uppercase 'B'.Provide all
X BoolandSomeMessagevariations forsendMessageandsendMessageWithNoRefresh, not justsendMessageWithNoRefreshToCurrent(renamed from
send).The new
tryInOrderBandtryMessageBfunctions accept a parameter oftype
SomeMessage -> X Bool, which means you are no longer constrainedto the behavior of the
sendMessageWithNoRefreshToCurrentdispatcher.The
send*Messages*family of funtions allows for sequencing arbitrarysets of messages with minimal refresh. It makes little sense for these
functions to support custom message dispatchers.
Remain backwards compatible. Maintain deprecated aliases of all renamed
functions:
send->sendMessageWithNoRefreshToCurrentBsendSM->sendSomeMessageWithNoRefreshToCurrentBsendSM_->sendSomeMessageWithNoRefreshToCurrenttryInOrder->tryInOrderWithNoRefreshToCurrentBtryInOrder_->tryInOrderWithNoRefreshToCurrenttryMessage->tryMessageWithNoRefreshToCurrentBtryMessage_->tryMessageWithNoRefreshToCurrentDescription
Include a description for your changes, including the motivation
behind them.
Checklist
I've read CONTRIBUTING.md
I tested my changes with xmonad-testing
I updated the
CHANGES.mdfile