Async: README가 npm에 너무 깁니다.

이것은 # 859와 접선 적으로 관련되어 있습니다. 잠시 동안 Async의 문서를 재검토하고 싶었습니다. Lodash의 문서와 더 유사한 사이트를 만드세요.

굉장 할 것입니다. 도움이 필요하십니까? 나는 당신이 # 859까지 얼마나 멀리 있는지 모르겠습니다.

우리는 정확한 구축 전략을 확정하지 않았습니다 (Lodash의 문서에 대한 유사한 푸시가 어떻게 작동하는지 기다리고 있음). 적어도 우리는 각 메소드에 대한 문서를 각 소스 파일 (전체 태그 및 유형 정보 포함)의 JSDoc 블록에 복사하고이를 구문 분석하고 문서 사이트를 구축하려고합니다.

@hargasinski 우리는 이것에 대한 도움을 확실히 사용할 수 있습니다. 귀하 또는 다른 사람이 우리 문서를 코드에서 jsdoc 호환 형식으로 이식하는 데 관심이 있다면 대단히 감사하겠습니다. 이 방법을 방법별로 수행하는 것이 좋습니다. 관심이 있으시면 여러 사람이 필요한 경우 기여할 수 있도록 작업 할 지점을 만들 수 있습니다.

영감을 찾고 있다면 https://github.com/lodash/lodash/blob/master/lodash.js#L8428 -L8470을 살펴보십시오.

JSDoc에 문서화 된 상태의 코드를 가져 오면 ramdas, lazys 또는 lodashs와 유사한 문서 사이트를 만들 수 있습니다.

@megawac 감사합니다! lodash가 어떻게하는지 살펴 보겠습니다. 내일은 쉬기 때문에 작업에 많은 시간을 할애 할 수있을 것입니다. 내가 얼마나 멀리 있는지에 대한 의견을 게시 할 것입니다.

이 작업에 걸리는 시간을 과소 평가했을지 모르지만 수집 방법에 대한 문서화를 완료 할 수있었습니다. 나머지는 퇴근 후 내일 끝낼 수있을 것 같아요. 지금까지 수행 한 작업과 변경해야 할 사항이 있는지 확인할 수 있도록 풀 리퀘스트를 생성했습니다. 몇 가지 간단한 질문이 있습니다.

1. 실제 async 생성자가 없으므로 @memberOf 태그를 계속 포함해야합니까?
2. @megawac 사이트의 경우 iteratee 및 callback 함수를 문서화하는 것이 가장 좋은 방법은 무엇입니까? readme에서 매개 변수에는 iteratee(item, callback) 와 같은 이름이 포함되어 있지만 jsdoc에서는 작동하지 않을 것이라고 생각합니다. 링크 한 lodash 예제와 유사한 작업을 수행하고 Invoked with (item, callback) 와 같이 @param 설명의 마지막 줄에 서명을 포함했습니다. 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 태그를 계속 포함해야합니까?

memberOf 비동기는 확실히 괜찮습니다. 또한, 니트 : 그것이 있습니다 memberOf 하지 memberof

사이트의 경우 iteratee 및 콜백 함수를 문서화하는 것이 가장 좋은 방법은 무엇입니까? readme에서 매개 변수에는 iteratee (item, callback)과 같은 이름이 포함되어 있지만 jsdoc에서는 작동하지 않을 것이라고 생각합니다.

실제로 완전히 확실하지 않습니다. @jdalton에 대한 생각이 있습니까? ramda가 사용자 정의 @sig 태그로 문서화한다는 것을 알고 있습니다.

또한 이것에 대해 서두르지 마십시오. 이것은 분명히 큰 작업이므로 우리가 계속해서 노력해 왔습니다. 그래도 조사해 주셔서 감사합니다!

문서 파서는 일반적으로 해당 비트를 처리합니다. 그렇지 않은 경우 재구성 할 수 있도록 구문 분석 된 출력을 제공해야합니다.

mapLimit 및 mapSeries 를 map 에 쉽게 연결할 수 있습니까 (예

지난 며칠 동안 pull request에 대한 커밋을 할 수 없었기 때문에 간단한 업데이트입니다. 계속해서 작업 할 것입니다. 웹 경험이 약간있어서 lodash 사이트 유지 관리 문제도 조사했습니다 . 충분히 멀어지면 진행 상황과 함께 저장소를 업로드 할 것입니다. 목표는 비동기도 사용할 수있는 무언가를 얻는 것입니다.

@hargasinski 의 변경 사항으로 로컬에서 문서를 생성하는 데 겪습니다 (현재 마스터에 있음). 나는이 템플릿 http://docstrap.github.io/docstrap/을 좋아한다고 생각 @hargasinski & @aearly의 생각

이전에 docstrap을 사용 해봤는데 정말 마음에 듭니다! 깨끗한 템플릿입니다. 테마에 대한 아이디어가 있습니까? 내 선호는 cerulean 또는 lumen 입니다. 더 어두운 것을 원한다면 슬레이트 도 좋습니다.

또한, 이번이 # 975를 해결하기에 좋은시기일까요? 사이트 로고가 있으면 좋을 것 같습니다

Docstrap은 꽤 좋아 보입니다. 그래도 검색 기능이 더 잘 작동 할 수 있다고 생각합니다. 테마는 우리가 쉽게 바꿀 수있는 것처럼 보이기 때문에 그다지 중요하지 않습니다. (그리고 그것들은 모두 똑같아 보입니다. 약간의 색상 차이를 제외하고는 다소 차이가 있습니다.)

https://github.com/lodash/lodash.github.io/issues/8 및 https://github.com/lodash/lodash.github.io/issues/15를 계속 주시하고 있습니다. JSDoc을 사용하면 그들이 채택한 모든 전략을 재사용 할 수 있습니다.

로고는 기다릴 수 있습니다. 좋은 로고 아이디어가 나올 때까지 멋진 서체로 "Async"를 사용할 수 있습니다. : stuck_out_tongue_closed_eyes :

@megawac JSDocs 게시에 대한 최근 작업이 있습니까? 2.0 릴리스 이전에 문서 사이트를 마련하는 것이 좋을 것입니다.

내 컴퓨터에서 jsdocs를 제대로 컴파일하려고 시도하는 동안 몇 가지 문제가 발생했습니다.

@aearly 언제 2.0 릴리스를 계획하고 있습니까? @megawac 현재는 시간을 할애 할 수 없지만 앞으로 2-3 주 동안이 문제를 해결하는 데 도움이 될 시간이 더있을 것입니다. 저를 올바른 방향으로 안내하거나 문제의 목록 만 나열 해 주시면 천천히 해결해 드릴 수 있습니다.

출시일이 없습니다. "준비가되면". 일부 새로운 메서드는 JSDoc을 통해서만 문서화되기 때문에 문서는 어려운 요구 사항이 아니라 가지고 있어도 좋은 것입니다.

@hargasinski 는 주로 이전에 @jsdoc을 사용한 적이 없으며 여러 파일에서 소싱하는 데 문제가 있습니다. 문서를 한 페이지에 게시하는 방법을 알 수 없었습니다. 내가 찾은 다른 문제는 typedef 구현 ( queue 및 cargo )이 제대로 표시되는 것입니다.

오, 고마워요. 다음 주 늦게까지 많은 일을 할 수는 없지만 repo를 포크하고 약간 놀아 볼게요. 가능한 것이 있으면 업데이트를 게시하겠습니다.