Despite the name, isMinTTY is only capable of detecting the presence of old versions of MinTTY. The name of the function is perhaps misleading in that regard, but it is widely used enough at this point to where renaming it would be disruptive. Instead, let's just clarify its intent in the documentation.
Description
This alters the Haddocks in System.Win32.MinTTY to clarify to which versions of MinTTY the isMinTTY and isMinTTYHandle functions apply.
Motivation and Context
Resolves #216.
Types of changes
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
[ ] My code follows the code style of this project.
[x] I have updated the documentation accordingly.
[ ] I have not added a new Haskell dependency.
[ ] I have included a changelog entry.
[ ] I have not modified the version of the package in Win32.cabal.
Mistuke
commented
1 year ago
Despite the name,
isMinTTYis only capable of detecting the presence of old versions of MinTTY. The name of the function is perhaps misleading in that regard, but it is widely used enough at this point to where renaming it would be disruptive. Instead, let's just clarify its intent in the documentation.Description
This alters the Haddocks in
System.Win32.MinTTYto clarify to which versions of MinTTY theisMinTTYandisMinTTYHandlefunctions apply.Motivation and Context
Resolves #216.
Types of changes
Checklist:
Win32.cabal.