From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) by finch.gentoo.org (Postfix) with ESMTP id A3EB513888F for ; Tue, 6 Oct 2015 15:40:51 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id A151FE0729; Tue, 6 Oct 2015 15:40:47 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 3B9B5E0729 for ; Tue, 6 Oct 2015 15:40:47 +0000 (UTC) Received: from professor-x (S010634bdfa9ecf80.vc.shawcable.net [96.49.31.57]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: dolsen) by smtp.gentoo.org (Postfix) with ESMTPSA id D9BBC3405D5 for ; Tue, 6 Oct 2015 15:40:42 +0000 (UTC) Date: Tue, 6 Oct 2015 08:39:53 -0700 From: Brian Dolbec To: gentoo-catalyst@lists.gentoo.org Subject: Re: [gentoo-catalyst] docstring standard Message-ID: <20151006083953.1a5b9da2.dolsen@gentoo.org> In-Reply-To: <20151006152110.GL6518@vapier.lan> References: <20151006152110.GL6518@vapier.lan> Organization: Gentoo Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-catalyst@lists.gentoo.org Reply-to: gentoo-catalyst@lists.gentoo.org MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-Archives-Salt: 96ae42c0-91cb-4470-952f-9409273e70b5 X-Archives-Hash: a8eaf61b7608cf71973a4c28d1613185 On Tue, 6 Oct 2015 11:21:10 -0400 Mike Frysinger wrote: > would be good to dictate now considering docstring coverage is so low. > personally i find the javadoc style to be unreadable and > unpythonic ;), so i'd propose the style clearly documented here: > https://google-styleguide.googlecode.com/svn/trunk/pyguide.html?showone=Comments#Comments > > i find it much easier to read at a glance. i've also written a pylint > module that checks its syntax :). > -mike It looks nice, but is yet another style to learn for me (minor). I have used the portage style in some new code, but the vast majority of the code is without much of any good docstrings. So, yeah, now is the time to decide, before it gets more difficult to change. I'd like to hear from the others in releng. -- Brian Dolbec