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 CF1A613888F for ; Tue, 6 Oct 2015 15:21:12 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 25D2AE086A; Tue, 6 Oct 2015 15:21:12 +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 A8CB8E086A for ; Tue, 6 Oct 2015 15:21:11 +0000 (UTC) Received: from vapier.lan (localhost [127.0.0.1]) by smtp.gentoo.org (Postfix) with SMTP id A619D340A8E for ; Tue, 6 Oct 2015 15:21:10 +0000 (UTC) Date: Tue, 6 Oct 2015 11:21:10 -0400 From: Mike Frysinger To: gentoo-catalyst@lists.gentoo.org Subject: [gentoo-catalyst] docstring standard Message-ID: <20151006152110.GL6518@vapier.lan> Mail-Followup-To: gentoo-catalyst@lists.gentoo.org 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: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="rmUrFcWP4LYae1gV" Content-Disposition: inline X-Archives-Salt: 7352c5b2-0451-4f5e-82c7-05baa052f527 X-Archives-Hash: 587d5a0905fd20c1c3db0f8d03a89831 --rmUrFcWP4LYae1gV Content-Type: text/plain; charset=utf-8 Content-Disposition: inline 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 --rmUrFcWP4LYae1gV Content-Type: application/pgp-signature; name="signature.asc" Content-Description: Digital signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 iQIcBAEBCAAGBQJWE+bmAAoJEEFjO5/oN/WBrtcQAIaebLFjlPzZwPMljxAry/o0 N5Sz/aAgmLInwSR2hoPQ9QPPLVq/F5QBZae86+FtRDADZkE2dmjW3DUiSKTi0SBI Px3KZfKUB6+Le0E8iJRBwhQdB6PdKOSBOdfzyrI0ycZ4vpM72DSi9HDtBWY8Ep4T 2zI6gKyT4FtPiRPKLy/le8VEqRaiaZVyW8q1W5yQ0qd/2fbdO4ScMKjHzXeZ4Ps1 Ji7S9two/VHiOXnOEi2fI40FQJTOZJoD26bQlP2teA2Nc+PKzBsbg3MKgnxXiN6h odj2U52/aWEVwrur4T2dG2tYv++v70n7i+q1davqV0Tsrz+wUTPxTy50XmgcoHTR 8vAXrHO6HLOFox9J5FUCNueo771akVAj5SRzE6zlEJ0nnXM2lywCxELMgArobSvT YhT9tnoUokrw9oh51y651F0WyWbwh7xy6BDsTkGE/r7nuodwE0bOSlTehLTPefUM aDLfOLl7Vell8KZA/RpyWZ7hYckGQxrYnmqJqv8ae2f1zsQ2H12uzBLnWKIp/k95 UjzJoISjM6KXaGA5QJB1n61mcw9PCHAIrP1SZe4IOa1H0PWLcB1tvfbGnGZtNGcX Lzq9/wLIE1PJphjRkmggNT2+NhP7nhVE7EsWHIBznKoTHY9RVtNIFWs4A+lxSSuV P2eUPwqL6XFyVIh/tbaF =SAvP -----END PGP SIGNATURE----- --rmUrFcWP4LYae1gV--