8
ऐसा लगता है कि हेडॉक प्रकार वर्ग तरीकों के लिए प्रति-तर्क डॉक्स से प्रस्तुत नहीं होती:क्या टाइप क्लास विधियों के लिए हैडॉक प्रति-तर्क दस्तावेज़ प्रस्तुत करने का कोई तरीका है?
class Foo a where
foo
:: Int --^This string will be ignored by Haddock
-> a
यह एक पुस्तकालय मैं बनाए रखने के उपयोगकर्ताओं के लिए कुछ मुद्दों का कारण बनता है, क्योंकि मेरे मामले में तरीकों काफी है लंबी हस्ताक्षर। मेरे पास हमेशा में विवरण स्वरूपित स्रोत हैं (निश्चित रूप से सामान्य कार्यों के लिए काम करता है), लेकिन यह पता चला है कि हैडॉक उन्हें प्रदर्शित नहीं करता है (और उनके बारे में शिकायत नहीं करता है या तो)।
क्या हैडॉक के साथ प्रति-तर्क दस्तावेज़ प्रदर्शित करने का कोई तरीका है? कुछ कामकाज शायद?
क्या आप एक प्रमुख एपीआई परिवर्तन करने के लिए खुले हैं? यदि ऐसा है, तो मैं एक [एकल रिकॉर्ड तर्क] का उपयोग करने के बारे में एक संक्षिप्त उत्तर लिख सकता हूं (https://byorgey.wordpress.com/2010/04/03/haskell-anti-pattern-incremental-ad-hoc-parameter- abstraction /) इसके लिए। –
हैडॉक 2.16.1 के साथ, मुझे प्रति-तर्क दस्तावेज़ों को स्टैंडअलोन फ़ंक्शंस के साथ-साथ कक्षा विधियों के लिए भी ठीक किया गया है। – leftaroundabout
@ बाएंअराउंडबाउट, मैं 2.17.1 के माध्यम से चल रहा हूं, यह: https://github.com/mrkkrp/megaparsec/blob/master/Text/Megaparsec.hs#L572-L575 उदाहरण के लिए, कोई प्रति-तर्क दस्तावेज़ नहीं। क्या आप मार्कअप में एक अंतर खोज सकते हैं, या यह एक प्रतिगमन है? – Mark