Как уменьшить дублирование документации с помощью Haddock

Question

У меня есть две очень похожие функции, и обе требуют одинаковую документацию. В Хэддоке есть способ избежать дублирования комментариев?

Я не смог найти описание этой функции в документации Хэддок, но я думаю, что есть способ сделать это.

Например, в Javadoc есть {@inheritDoc} а также @see SomeClass#someMethod(), Как насчет пикши?

Answer 1

К сожалению, в настоящее время объявления функций не могут иметь документацию многократного использования с Haddock. Вот проблема отслеживания этого.

-- $chunk_name именование фрагментов документации доступно только для документации модуля, т.е. для раздела экспорта. Это удобно только для перемещения документации от верхней части модуля к нижней части, чтобы уменьшить беспорядок.

Обычные обходные пути для этой проблемы:

• убедитесь, что аналогичная функция находится в области действия и добавьте это в документацию: -- | See `functionName`. OR -- | See 'functionName'.
• или вручную скопируйте и вставьте документацию, если она достаточно мала, аналогично тому, как это делается в bytestring а также vector пакеты.