From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Original-To: caml-list@sympa.inria.fr Delivered-To: caml-list@sympa.inria.fr Received: from mail2-relais-roc.national.inria.fr (mail2-relais-roc.national.inria.fr [192.134.164.83]) by sympa.inria.fr (Postfix) with ESMTPS id 0FA5A7FFB3 for ; Mon, 14 Mar 2016 22:06:00 +0100 (CET) IronPort-PHdr: 9a23:uwZ5iRU4P33NDhpUHajeSpVB1HzV8LGtZVwlr6E/grcLSJyIuqrYZh2Pt8tkgFKBZ4jH8fUM07OQ6PC/Hz1eqs/d7jgrS99laVwssY0uhQsuAcqIWwXQDcXBSGgEJvlET0Jv5HqhMEJYS47UblzWpWCuv3ZJQk2sfTR8Kum9IIPOlcP/j7n0oM2MJVQWz2PhP/tbF1afk0b4joEum4xsK6I8mFPig0BjXKBo/15uPk+ZhB3m5829r9ZJ+iVUvO89pYYbCf2pN4xxd7FTDSwnPmYp/4Wr8ECbFUrc0EABSX0bmQZkBA3M7ReyHsug83iyiu0o6S6GNMi+Z7kuXzOzp/N6TwPhjS0OLTg+4UnYj8VxiORQpxf39DJlxIuBQpyTL/14cev5fJtOQWhaGMpYTS9PA5i8R4QKBusFe+1fqt+u9BM1sRKiCFz0V6vUwThSiyqzgPQ3 Authentication-Results: mail2-smtp-roc.national.inria.fr; spf=None smtp.pra=ljs.darkfish@gmail.com; spf=Pass smtp.mailfrom=ljs.darkfish@gmail.com; spf=None smtp.helo=postmaster@mail-pa0-f41.google.com Received-SPF: None (mail2-smtp-roc.national.inria.fr: no sender authenticity information available from domain of ljs.darkfish@gmail.com) identity=pra; client-ip=209.85.220.41; receiver=mail2-smtp-roc.national.inria.fr; envelope-from="ljs.darkfish@gmail.com"; x-sender="ljs.darkfish@gmail.com"; x-conformance=sidf_compatible Received-SPF: Pass (mail2-smtp-roc.national.inria.fr: domain of ljs.darkfish@gmail.com designates 209.85.220.41 as permitted sender) identity=mailfrom; client-ip=209.85.220.41; receiver=mail2-smtp-roc.national.inria.fr; envelope-from="ljs.darkfish@gmail.com"; x-sender="ljs.darkfish@gmail.com"; x-conformance=sidf_compatible; x-record-type="v=spf1" Received-SPF: None (mail2-smtp-roc.national.inria.fr: no sender authenticity information available from domain of postmaster@mail-pa0-f41.google.com) identity=helo; client-ip=209.85.220.41; receiver=mail2-smtp-roc.national.inria.fr; envelope-from="ljs.darkfish@gmail.com"; x-sender="postmaster@mail-pa0-f41.google.com"; x-conformance=sidf_compatible X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: A0BMBAB+J+dWcincVdFdhBheDwaCb6cEkEuBcCGFbAKBKwc6EgEBAQEBAQEBEAEKCwwIHzFBEAGBW4IUAQEBAwEMBhEdARsPAwsBAwELBgMCCw0CAgkdAgIhAQERAQUBChIGExIQh2wBAwoIDo88j0GBMT4xizaBaoJXhVYKGScDChU8g3MBAQEBAQUBAQEBFgEFCgVtiGB+gj2Be4MCgToFhiAMiAGJHoVuhh2BdYFlS4ckhTGHKoYVER6BDycLgiaCDhwugSWJPgEBAQ X-IPAS-Result: A0BMBAB+J+dWcincVdFdhBheDwaCb6cEkEuBcCGFbAKBKwc6EgEBAQEBAQEBEAEKCwwIHzFBEAGBW4IUAQEBAwEMBhEdARsPAwsBAwELBgMCCw0CAgkdAgIhAQERAQUBChIGExIQh2wBAwoIDo88j0GBMT4xizaBaoJXhVYKGScDChU8g3MBAQEBAQUBAQEBFgEFCgVtiGB+gj2Be4MCgToFhiAMiAGJHoVuhh2BdYFlS4ckhTGHKoYVER6BDycLgiaCDhwugSWJPgEBAQ X-IronPort-AV: E=Sophos;i="5.24,337,1454972400"; d="scan'208";a="207734800" Received: from mail-pa0-f41.google.com ([209.85.220.41]) by mail2-smtp-roc.national.inria.fr with ESMTP/TLS/AES128-GCM-SHA256; 14 Mar 2016 22:05:58 +0100 Received: by mail-pa0-f41.google.com with SMTP id fl4so164336041pad.0 for ; Mon, 14 Mar 2016 14:05:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc:content-transfer-encoding; bh=GMOKFMoam3pwjfEOXbPeIJbx86lqJpp4HU+EHQiCCss=; b=ANooJWK6Jj6HnquWigdAuw/BlnBY2ewptSDoYmffipYkBMkw6uxbazyDcobammCghH TwqvmHsQ+8z0YGLckBYb2V1AjUl1SDpd3HS8hXAAvxG+ZVveqgKzMayBXCELoiz/Gwog R7o2HvGWq0UKZRKkLa1y62uUOj470a1XTJSxHOvlcedRefIxUnGYBV4v2OhLGKeZbmE/ LFgJQh107H8DR3i5Ft+RS4LuJPGqCx8Ds5zeOybiKK3npZzC9NKdGo4eY2hvaIMwziB6 kBE/2zPshdxR2RCjTezLRGFxKjK+SM4tJ55fRrxNlAt1N31AZQbQyAYi5x84j0qol0dJ lbSw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:in-reply-to:references:date :message-id:subject:from:to:cc:content-transfer-encoding; bh=GMOKFMoam3pwjfEOXbPeIJbx86lqJpp4HU+EHQiCCss=; b=JqzqqmR+dUhL3VL+Qqfa+MY21HRvl/9W4EQt0MQtkRU/xFyKBgh8kw2Nj2dL4q2qLN Cur0fFbvQMvgqLsAWfjHaOUbRVsQngMMFhtbWZGs19XNALVDhAwtPsf1NXqj/X0tswqY MKTe3Yl9W4X10q/bi8+2vX1f3B7tOUtVomB4Nztom4YrfPYtYGD7eIKh86swtWA9FF93 vLmoGsUFDvyomaq0LDm3Fb5FYc9bwlxwv09ogTnTSGeLH76mtrC7WOHFcBSLw1BQHDAu ZXgFRZ3X6AJXUKhDkwfnHEI82ACuUcPscq3VC8VSP0I24m7x91e9MYBoFeyk7RniPcWt 51wg== X-Gm-Message-State: AD7BkJKg4ROqYPEYIJrzforCDxEWVUkRrVL8vGM9JruDLEcUUkCl+fa98CZKXciPx8wjZWfhVvPeQVCMeNxglA== MIME-Version: 1.0 X-Received: by 10.66.100.196 with SMTP id fa4mr41167107pab.37.1457989556815; Mon, 14 Mar 2016 14:05:56 -0700 (PDT) Received: by 10.66.2.167 with HTTP; Mon, 14 Mar 2016 14:05:56 -0700 (PDT) In-Reply-To: References: <20160314103608.GB21595@frosties> Date: Mon, 14 Mar 2016 14:05:56 -0700 Message-ID: From: Junsong Li To: Yotam Barnoy Cc: Gabriel Scherer , Goswin von Brederlow , Ocaml Mailing List Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Subject: Re: [Caml-list] Flambda/compiler walkthrough + modularity May I ask whether we have module owners in the core team? That is, are modules assigned to people in the core team? Generally I think it is a bad idea, but if it is done so, owners can review the crowd-sourced comments in their module. Or, can people voluntarily review the crowd-sourced comments in modules that they know well? Thanks. We eventually get to the comments. When I read the ocamldoc source, I had a few Aha moments, but I had no idea what to do about them: maybe I should write it down somewhere, but as it is not close to the source, it will be obsoleted anyway. Why bother? On Mon, Mar 14, 2016 at 6:51 AM, Yotam Barnoy wrote: > On Mon, Mar 14, 2016 at 8:30 AM, Gabriel Scherer > wrote: >> >> A nice quality of in-code comments that a video session does not have is >> locality: the explanations are closed to the explainees, so hopefully th= ey >> can evolve in synch. Another nice quality (shared with blog posts) is th= at >> it can be proposed by third-parties and crowd-sourced with moderate >> efficiency: you can help document the OCaml implementation by sending a >> pull-request with comments on the parts you fought to understand. >> >> This has notably been done by Alain Frisch for the parsetree >> representation during the 4.01 development phase, and recently (4.03 >> development cycle, GPR#310) in types.mli and typedtree.mli by Fr=C3=A9d= =C3=A9ric Bour, >> Gabriel Radanne and Thomas Refis, with helpful feedback from Alain Frisch >> and Jacques Garrigue. >> >> Anyone can help by submitting their own contribution to >> documentation-as-comments. >> > > This is absolutely true, and I'm extremely grateful to all who commented = -- > the results are wonderful. The barriers to entry in this case, however, a= re > knowledge, quality and effort. By contrast, Jacques Garrigue (sorry for > picking on you Jacques) recording a session off the cuff on his laptop as= he > casually steps through the code in his editor (he wouldn't even need a > webcam) and then uploading it to youtube would be a tremendous resource in > and of itself. > > Another idea is that we develop a protocol for doing precisely this kind = of > evolutionary crowdsourced commenting, but take the initial barrier out of > it. Suppose that we allowed opening PRs on random files in the codebase.= I > (or others) would ask questions about functions I didn't understand, and > other people would step up and explain them. Eventually, there might be s= ome > documentation and clarification to add to the code. This would require > tolerance of 'unhelpful' and question-based documentation PRs. There might > be some very basic questions in there. We could add a specific tag, so th= ese > PRs aren't closed prematurely (they could take a while). Would that be ok? > > -Yotam > >> >> On Mon, Mar 14, 2016 at 11:36 AM, Goswin von Brederlow >> wrote: >>> >>> On Fri, Mar 11, 2016 at 12:04:17PM -0500, Yotam Barnoy wrote: >>> > While thinking about the best way to learn the new Flambda code in the >>> > minimal amount of time, I thought to myself, "wouldn't it be amazing = to >>> > have Pierre Chambart and Mark Shinwell just do a video walkthrough of >>> > their >>> > code". And then I thought about the rest of the codebase, about Jacqu= es >>> > Garrigue doing a walkthrough of the typechecker code, and each >>> > expert(s) >>> > talking about the parts they know really well, and about how amazing = it >>> > would be if we had this resource on youtube. It would be the ultimate >>> > form >>> > of documentation by the foremost experts on aspects OCaml, welcoming >>> > programmers to contribute to the OCaml compiler in the easiest way >>> > possible. >>> > >>> > A step further would be if this was done on Twitch or some similar li= ve >>> > broadcasting platform, so people could actually ask live questions as >>> > the >>> > session took place. The resulting video would be posted to youtube. >>> > >>> > What do you guys think? >>> > >>> > -Yotam >>> >>> I would watch that. >>> >>> MfG >>> Goswin >>> >>> -- >>> Caml-list mailing list. Subscription management and archives: >>> https://sympa.inria.fr/sympa/arc/caml-list >>> Beginner's list: http://groups.yahoo.com/group/ocaml_beginners >>> Bug reports: http://caml.inria.fr/bin/caml-bugs >> >> >