copilot-core: module Copilot.Core.PrettyDot is unnecessary #359
Description
Description
The module Copilot.Core.PrettyDot is not being used by any other part of Copilot or, as far as we know, by any user of Copilot. It is not a necessary part of the interface to use Copilot, and not required by Copilot's requirements. Although the idea is good, there is consensus that it is not needed at this point.
Therefore, it would be suitable to remove this module.
As per our internal policy of waiting 3 versions from deprecation until a public interface declaration can be removed, this module can now be deprecated.
Type
- Bug: unused code included in the implementation.
Additional context
None.
Requester
- Ivan Perez
Method to check presence of bug
The following expression finds uses of Copilot.Core.PrettyDot, ignoring appearances in comments or strings.
$ grep -nHre ' \<Copilot.Core.PrettyDot\>' --include='*.hs' | grep -ve '^{-#' | grep -ve '--.*Copilot.Core.PrettyDot' | grep -ve '"[^"]*Copilot.Core.PrettyDot[^"]*"'
copilot-core/src/Copilot/Core/PrettyDot.hs:8:module Copilot.Core.PrettyDotThe result obtained is just the module declaration.
Expected result
The string should be either empty (module is not used) or list further uses.
Desired result
The string returned by the command above should be empty. Upon deprecation, the following command should fail:
$ ghci -Werror=deprecations -e 'import Copilot.Core.PrettyDot'
Proposed solution
Deprecate the module Copilot.Core.PrettyDot.
Further notes
None.