Async: README npm के लिए बहुत लंबा है

यह स्पर्शरेखा रूप से #859 से संबंधित है। हम कुछ समय के लिए Async के दस्तावेज़ों को फिर से बदलना चाहते हैं -- Lodash के दस्तावेज़ों के समान एक साइट बनाएँ।

यह बहुत अच्छा होगा, क्या आपको इसके लिए किसी मदद की ज़रूरत है? मैं नहीं जानता कि आप #८५९ के साथ कितनी दूर हैं।

हमने सटीक निर्माण रणनीति को अंतिम रूप नहीं दिया है (यह देखने के लिए प्रतीक्षा कर रहा है कि लोडाश के दस्तावेज़ों के लिए एक समान धक्का कैसे काम करता है)। कम से कम, हम प्रत्येक विधि के दस्तावेज़ों को प्रत्येक स्रोत फ़ाइल (पूर्ण टैग और प्रकार की जानकारी के साथ) में JSDoc ब्लॉक में कॉपी करना चाहते हैं, उन्हें पार्स करने और उनसे एक दस्तावेज़ साइट बनाने के इरादे से।

@hargasinski हम निश्चित रूप से इसके साथ मदद का उपयोग कर सकते हैं। यदि आप या कोई और हमारे डॉक्स को jsdoc कोड में संगत स्वरूपण में पोर्ट करने में मदद करने में रुचि रखते हैं तो इसकी बहुत सराहना की जाएगी। मैं इस विधि को विधि द्वारा करने की सलाह देता हूं। यदि आप रुचि रखते हैं तो मैं काम करने के लिए एक शाखा बना सकता हूं ताकि जरूरत पड़ने पर कई लोग योगदान दे सकें

यदि आप प्रेरणा की तलाश में हैं तो https://github.com/lodash/lodash/blob/master/lodash.js#L8428 -L8470 पर एक नज़र डालें।

अगर हमें उस राज्य में कोड मिलता है जहां इसे JSDoc में प्रलेखित किया गया है, तो मैं रामदास, आलसी या लॉश के समान एक डॉक्स साइट बना सकता हूं

@megawac धन्यवाद! मैं देखूंगा कि लॉश यह कैसे करता है। मेरे पास कल की छुट्टी है, इसलिए मैं शायद इस पर काम करने में काफी समय लगा सकता हूं। मैं एक टिप्पणी पोस्ट करूंगा कि मुझे कितनी दूर जाना है।

हो सकता है कि मैंने इसमें लगने वाले समय को कम करके आंका हो, लेकिन मैं संग्रह विधियों के लिए दस्तावेज़ीकरण समाप्त करने में सक्षम था। मुझे काम के बाद कल बाकी काम खत्म करने में सक्षम होना चाहिए। मैंने एक पुल अनुरोध बनाया है ताकि आप देख सकें कि मैंने अब तक क्या किया है, और अगर कुछ बदलने की जरूरत है। मेरे पास कुछ त्वरित प्रश्न हैं।

1. चूंकि कोई वास्तविक async कंस्ट्रक्टर नहीं है, क्या मुझे @memberOf टैग को शामिल करते रहना चाहिए?
2. @megawac साइट के लिए, iteratee और callback फ़ंक्शंस का दस्तावेज़ीकरण करना सबसे अच्छा कैसे होगा? रीडमी में, पैरामीटर नाम शामिल हैं, जैसे iteratee(item, callback) , लेकिन मुझे नहीं लगता कि यह jsdoc के साथ काम करेगा। मैं आपके द्वारा लिंक किए गए लॉश उदाहरण के समान कुछ कर रहा हूं, और हस्ताक्षर को @param विवरण में अंतिम पंक्ति के रूप में शामिल कर रहा हूं, जैसे Invoked with (item, callback) । Jsdoc साइट कुछ इस तरह की सिफारिश करती है:

/**
 * Send a request.
 * <strong i="19">@param</strong> {requestCallback} cb - The callback that handles the response.
 */
Requester.prototype.send = function(cb) {
    // code
};

/**
 * This callback is displayed as a global member.
 * <strong i="20">@callback</strong> requestCallback
 * <strong i="21">@param</strong> {number} responseCode
 * <strong i="22">@param</strong> {string} responseMessage
 */

चूंकि कोई वास्तविक एसिंक कंस्ट्रक्टर नहीं है, क्या मुझे

memberOf async निश्चित रूप से ठीक है। इसके अलावा, नाइट: ध्यान दें कि यह memberOf न कि memberof

साइट के लिए, पुनरावृति और कॉलबैक फ़ंक्शंस का दस्तावेजीकरण करना सबसे अच्छा कैसे होगा? रीडमी में, पैरामीटर नाम शामिल हैं, जैसे कि iteratee (आइटम, कॉलबैक), लेकिन मुझे नहीं लगता कि यह jsdoc के साथ काम करेगा।

मैं वास्तव में पूरी तरह से निश्चित नहीं हूं, क्या विचार @jdalton हैं? मुझे पता है कि ramda इसे एक कस्टम @sig टैग के साथ दस्तावेज़ करता है

साथ ही इस पर कोई जल्दबाजी न करें, यह निश्चित रूप से एक बड़ा काम है, यही वजह है कि हमने इस पर ध्यान देना जारी रखा है। हालांकि इसमें देखने के लिए धन्यवाद!

डॉक्टर पार्सर्स आमतौर पर उस बिट को संभालते हैं। यदि नहीं, तो उन्हें आपके पुनर्निर्माण के लिए पार्स किए गए आउटपुट प्रदान करना चाहिए।

क्या आसानी से लिंक करना संभव है (उदाहरण के लिए) mapLimit और mapSeries से map ? आपको बस इतना कहना है कि वे समवर्ती-सीमित संस्करण हैं। अन्यथा बहुत सारे डुप्लीकेट डॉक्स और उदाहरण होने जा रहे हैं। (मुझे लगता है कि हस्ताक्षर रखना ठीक है, हालांकि)

अरे, बस एक त्वरित अपडेट क्योंकि मैं पिछले कुछ दिनों में पुल अनुरोध के लिए कोई प्रतिबद्धता नहीं बना पाया हूं। मैं अभी भी इस पर काम करना जारी रखूंगा। मेरे पास थोड़ा सा वेब अनुभव है, इसलिए मैं लॉश साइट रखरखाव के मुद्दे को भी देख रहा हूं। एक बार जब मैं इसमें काफी दूर हो जाऊंगा तो मैं अपनी प्रगति के साथ भंडार अपलोड करूंगा। लक्ष्य कुछ ऐसा प्राप्त करना है जो async भी उपयोग कर सके।

@hargasinski के परिवर्तनों (अब मास्टर पर) के साथ स्थानीय रूप से दस्तावेज़ बनाने के साथ खिलवाड़ करना। मुझे लगता है कि मुझे यह टेम्पलेट http://docstrap.github.io/docstrap/ पसंद है @hargasinski और @aearly

मैंने पहले डॉकस्ट्रैप का उपयोग किया है, मुझे यह वाकई पसंद है! यह एक साफ टेम्पलेट है। विषय पर कोई विचार? मेरी पसंद सेरुलियन या लुमेन होगी । यदि आप कुछ गहरा करना चाहते हैं तो स्लेट भी अच्छा है।

साथ ही, क्या यह #975 को संबोधित करने का एक अच्छा समय होगा? साइट के लिए लोगो होना अच्छा होगा

डॉकस्ट्रैप बहुत अच्छा लग रहा है। मुझे लगता है कि खोज सुविधा बेहतर काम कर सकती है, हालांकि। विषय बहुत ज्यादा मायने नहीं रखता क्योंकि ऐसा लगता है कि हम इसे आसानी से बदल सकते हैं। (और वे सभी वही हैं जो ऐसा लगता है, कुछ रंग मतभेदों के लिए बचाओ, कम या ज्यादा।)

अभी भी https://github.com/lodash/lodash.github.io/issues/8 और https://github.com/lodash/lodash.github.io/issues/15 पर नजर रख रहे हैं - चूंकि दोनों परियोजनाएं हैं JSDoc का उपयोग करके, हम उनके द्वारा अपनाई गई किसी भी रणनीति का पुन: उपयोग कर सकते हैं।

लोगो प्रतीक्षा कर सकता है, हम एक अच्छे टाइपफेस में "Async" का उपयोग तब तक कर सकते हैं जब तक कि एक अच्छा लोगो विचार साथ न आ जाए। :जीभ बाहर, आंखें बंद:

@megawac हमारे JSDocs को प्रकाशित करने पर कोई और हालिया काम? 2.0 रिलीज से पहले डॉक्स साइट को जगह में रखना बहुत अच्छा होगा।

मुझे उन्हें बनाने के लिए बुरी किस्मत मिली है और मेरी मशीन पर जेएसडॉक्स को ठीक से संकलित करने की कोशिश कर रहे कई मुद्दों में भाग लिया है

@ २.० रिलीज करने की योजना कब बना रहे हैं? @megawac वर्तमान में, मैं समय की प्रतिबद्धता नहीं बना सकता, लेकिन इस पर काम करने में आपकी सहायता के लिए मेरे पास अगले 2-3 सप्ताह में कुछ और समय होना चाहिए। यदि आप मुझे सही दिशा में मार्गदर्शन करने में सक्षम होंगे, या बस कुछ मुद्दों की सूची देंगे, तो मैं धीरे-धीरे उन्हें दूर करने में मदद कर सकता हूं।

हमारे पास कोई रिलीज़ दिनांक नहीं है -- "जब यह तैयार हो"। दस्तावेज़ एक कठिन आवश्यकता नहीं है, केवल एक प्रमुख अच्छी-से-अच्छी है, क्योंकि कुछ नई विधियों को केवल JSDoc के माध्यम से प्रलेखित किया जाता है।

@hargasinski इसका मुख्य रूप से मैंने पहले कभी @jsdoc का उपयोग नहीं किया है और इसे कई फाइलों से सोर्सिंग जारी कर रहा हूं। मुझे समझ नहीं आ रहा था कि डॉक्स को एक पेज पर कैसे लाइव किया जाए। दूसरा मुद्दा जो मैंने पाया वह था typedef कार्यान्वयन ( queue और cargo ) ठीक से दिखने के लिए

ओह ठीक है, धन्यवाद, मैं रेपो को फोर्क कर दूंगा और इसके साथ थोड़ा खेलूंगा, हालांकि मैं अगले सप्ताह के अंत तक बहुत कुछ नहीं कर पाऊंगा। अगर मुझे कुछ भी संभव हो तो मैं एक अपडेट पोस्ट करूंगा।