Замечания отладчика для импортированных объектов

Question

Есть ли способ добавить документацию отладчика к объекту в модуле, который его экспортирует, а не тот, который его объявляет?

У меня есть скрытый модуль, который объявляет десяток типов или около того, а затем еще один модуль, который экспортирует только те части, которые должен видеть конечный пользователь. Было бы логично поставить документацию в открытый модуль, а не на скрытый. Но я не могу понять, как это сделать ...

Answer 1

Нет, это невозможно. Функции могут иметь в-аргумент и за тип-пары документации, и это сделало бы документацию противоречивой, если вы могли бы:

1. написать различные версии в разных местах
2. есть одна версии замещают другой
3. ввести несоответствия в аргументация: что, если вы переопределите основную строку документа для функции; следует ли удалить строки аргумента doc?

следующий файл:

module Bla 
     (-- * Fooishness 

     -- | This is 'foo'. It is not 'bar'. 
     foo 
     , -- * Barishness 

     -- | This is 'bar'. It is sometimes a little 'foo'. 
     bar 
     ) where 

-- | The actual foo documentation 
foo :: a --^The a 
    -> b --^The b 
    -> c 
foo = undefined 

-- | The actual bar documentation 
bar :: a 
bar = undefined 

... дает эту документация:

Как вы можете видеть, вы можете использовать раздел комментарии для рода эмулировать строки функции документации , но документация будет только сгенерирована должным образом, если вы будете использовать комментарии к документации по функциям подписями типов.

Answer 2

Ну, подумайте об этом, я мог бы написать newtype в открытом модуле. Он не несет накладных расходов вовремя, это просто делает мой код немного более грязным ...