Async: README أطول من أن npm

هذا مرتبط بشكل طفيف بالرقم 859 #. لقد أردنا إعادة تصميم مستندات Async لفترة من الوقت - إنشاء موقع أكثر تشابهًا مع مستندات Lodash.

سيكون ذلك رائعًا ، هل تحتاج إلى أي مساعدة في ذلك؟ أنا لا أعرف إلى أي مدى أنت على طول # 859.

لم ننتهي من استراتيجية البناء الدقيقة (ننتظر لنرى كيف تعمل دفعة مماثلة لمستندات لودش). على الأقل ، نريد نسخ المستندات الخاصة بكل طريقة إلى كتلة JSDoc في كل ملف مصدر (مع العلامات الكاملة ومعلومات الكتابة) ، بهدف تحليلها وبناء موقع توثيق منها.

hargasinski يمكننا بالتأكيد استخدام المساعدة في هذا. إذا كنت أنت أو أي شخص آخر مهتمًا بالمساعدة في نقل مستنداتنا إلى تنسيق متوافق مع jsdoc في الكود ، فسيكون ذلك موضع تقدير كبير. أوصي بعمل هذه الطريقة بطريقة. إذا كنت مهتمًا ، يمكنني إنشاء فرع للعمل به بحيث يمكن للعديد من الأشخاص المساهمة إذا لزم الأمر

ألق نظرة على https://github.com/lodash/lodash/blob/master/lodash.js#L8428 -L8470 إذا كنت تبحث عن الإلهام.

إذا حصلنا على الكود في حالة تم توثيقه فيها في JSDoc ، يمكنني إنشاء موقع مستندات مشابه لـ ramdas أو lazys أو Lodash

megawac شكرا لك! سأبحث في كيفية عمل اللوداش. لدي عطلة غدًا ، لذا ربما يمكنني قضاء وقت طويل في العمل عليه. سأقوم بنشر تعليق على المدى الذي وصلت إليه.

ربما أكون قد قللت من مقدار الوقت الذي سيستغرقه هذا ، لكنني تمكنت من إنهاء الوثائق الخاصة بأساليب الجمع. يجب أن أكون قادرًا على إنهاء الباقي غدًا بعد العمل. لقد قمت بإنشاء طلب سحب حتى تتمكن من رؤية ما قمت به حتى الآن ، وما إذا كان هناك أي شيء يحتاج إلى التغيير. لدي بضعة أسئلة سريعة.

1. نظرًا لعدم وجود مُنشئ async حقيقي ، هل يجب أن أستمر في تضمين علامة
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 غير المتزامن أمر جيد بالتأكيد. أيضًا ، nit: لاحظ أنه memberOf وليس memberof

بالنسبة للموقع ، ما هي أفضل طريقة لتوثيق وظيفتي التكرار والاستدعاء؟ في الملف التمهيدي ، تُدرج المعلمات الاسم ، مثل iteratee (item ، callback) ، لكنني لا أعتقد أن هذا سيعمل مع jsdoc.

لست متأكدًا تمامًا ، هل لديك أفكارjdalton؟ أعرف أن ramda توثقها بعلامة @sig مخصصة

أيضًا ، لا داعي للاندفاع في هذا الأمر على الإطلاق ، فهذه بالتأكيد مهمة كبيرة ولهذا السبب واصلنا تأجيلها. شكرا للنظر في ذلك على الرغم من!

عادةً ما يتعامل محللو المستندات مع هذا الجزء. إذا لم يكن الأمر كذلك ، فيجب عليهم توفير الإخراج المحلل لك لإعادة البناء.

هل من الممكن الربط بسهولة (على سبيل المثال) mapLimit و mapSeries بـ map ؟ كل ما عليك قوله هو أنها إصدارات محدودة التزامن. وإلا فسيكون هناك الكثير من المستندات والأمثلة المكررة. (أعتقد أن الاحتفاظ بالتوقيع لا بأس به ، رغم ذلك)

مرحبًا ، مجرد تحديث سريع لأنني لم أتمكن من تقديم أي التزامات لطلب السحب في الأيام القليلة الماضية. ما زلت سأواصل العمل عليها. لديّ القليل من الخبرة على الويب ، لذلك كنت أبحث أيضًا في مشكلة صيانة موقع اللوداش. سوف أقوم بتحميل المستودع مع تقدمي بمجرد أن أحصل على مسافة كافية فيه. الهدف هو الحصول على شيء غير متزامن يمكن استخدامه أيضًا.

العبث بتوليد التوثيق محليًا مع تغييرات http://docstrap.github.io/docstrap/. خواطر hargasinski & aearly

لقد استخدمت docstrap من قبل ، لقد أحببته حقًا! إنه قالب نظيف. أي فكرة عن الموضوع؟ أفضل ما لدي هو الخزف أو التجويف . Slate جميل أيضًا إذا كنت تريد البحث عن شيء أكثر قتامة.

أيضًا ، هل سيكون هذا هو الوقت المناسب للتعامل مع # 975؟ سيكون من الجيد أن يكون لديك شعار للموقع

تبدو Docstrap جيدة جدًا. أشعر أن ميزة البحث يمكن أن تعمل بشكل أفضل. لا يهم الموضوع كثيرًا لأنه يبدو أنه يمكننا تغييره بسهولة. (ويبدو أنهم جميعًا متشابهون ، باستثناء بعض الاختلافات في الألوان ، أكثر أو أقل.)

لا تزال تراقب https://github.com/lodash/lodash.github.io/issues/8 و https://github.com/lodash/lodash.github.io/issues/15 - نظرًا لأن كلا المشروعين هما باستخدام JSDoc ، يمكننا إعادة استخدام أي استراتيجية يتبنونها.

يمكن أن ينتظر الشعار ، يمكننا استخدام "Async" في شكل محرف لطيف حتى تأتي فكرة شعار جيدة. :ملجوم اللسان مغمض العينين:

megawac هل هناك أي عمل آخر حول نشر محرر JSD؟ سيكون من الرائع أن يكون لديك موقع المستندات في مكانه قبل الإصدار 2.0.

لقد كان حظي سيئًا في حملهم على البناء وواجهت العديد من المشكلات أثناء محاولة تجميع مستندات jsdocs بشكل صحيح على جهازي

aearly متى تخطط للقيام بإصدار 2.0؟ megawac حاليًا ، لا يمكنني الالتزام بالوقت ، ولكن يجب أن يكون لدي المزيد من الوقت في الأسابيع 2-3 القادمة لمساعدتك في العمل على هذا. إذا كنت قادرًا على إرشادي في الاتجاه الصحيح ، أو مجرد قائمة ببعض المشكلات ، فيمكنني المساعدة في التخلص منها ببطء.

ليس لدينا تاريخ إطلاق - "عندما يكون جاهزا". لا تعد المستندات مطلبًا صعبًا ، بل مجرد شيء أساسي ، نظرًا لأن بعض الأساليب الجديدة يتم توثيقها فقط من خلال JSDoc.

hargasinski ، بشكل أساسي ، لم أستخدم jsdoc من قبل typedef ( queue و cargo ) لتظهر بشكل صحيح

حسنًا ، شكرًا لك ، سأفقد الريبو وألعب به قليلاً ، على الرغم من أنني لن أتمكن من إنجاز الكثير حتى أواخر الأسبوع المقبل. سأقوم بنشر تحديث إذا حصلت على أي شيء ممكن.