Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-9.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 31B56C4363C for ; Wed, 7 Oct 2020 07:26:28 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 60143207EA for ; Wed, 7 Oct 2020 07:26:27 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="Yd3Mb7zt" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 60143207EA Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:37304 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kQ3qE-0008MW-81 for qemu-devel@archiver.kernel.org; Wed, 07 Oct 2020 03:26:26 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:60724) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kQ3op-0007D6-3q for qemu-devel@nongnu.org; Wed, 07 Oct 2020 03:24:59 -0400 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:57260) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kQ3on-0001N9-63 for qemu-devel@nongnu.org; Wed, 07 Oct 2020 03:24:58 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1602055496; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=BDNlj5vd7UMayVsEr/U4be+ZskHCDe4RyG0nI0GbcFQ=; b=Yd3Mb7ztZWz1lcIaeEt7B9onP+KB0KG9N/RIIUCBaKpQFcWuheeDFvw4scemf1lC+YGgeL VeAwMqJp8YZn9Do9dQDBVGKPAOlDUsAZGZ+ZyiQqx9ijHQ4HW1GejIM7Rftj0oIP6riukQ 2Wqojx+N/rS86uBIf/QsCr9uTrxfAO0= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-590-8iVKLL9LPaG9hIS9jz4Q5g-1; Wed, 07 Oct 2020 03:24:53 -0400 X-MC-Unique: 8iVKLL9LPaG9hIS9jz4Q5g-1 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id A4EEC18CB723 for ; Wed, 7 Oct 2020 07:24:52 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-112-182.ams2.redhat.com [10.36.112.182]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 496181002C22; Wed, 7 Oct 2020 07:24:52 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id BFEC711329C1; Wed, 7 Oct 2020 09:24:50 +0200 (CEST) From: Markus Armbruster To: John Snow Subject: Re: [PATCH v5 02/36] qapi: modify docstrings to be sphinx-compatible References: <20201005195158.2348217-1-jsnow@redhat.com> <20201005195158.2348217-3-jsnow@redhat.com> <87r1qbtxb1.fsf@dusky.pond.sub.org> <5f95ee89-78be-424b-906e-56b4f9bf76a5@redhat.com> Date: Wed, 07 Oct 2020 09:24:50 +0200 In-Reply-To: <5f95ee89-78be-424b-906e-56b4f9bf76a5@redhat.com> (John Snow's message of "Tue, 6 Oct 2020 11:23:11 -0400") Message-ID: <87sgaqjy65.fsf@dusky.pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=armbru@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain Received-SPF: pass client-ip=63.128.21.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/10/07 00:44:56 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.733, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Cleber Rosa , qemu-devel@nongnu.org, Eduardo Habkost Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" John Snow writes: > On 10/6/20 7:21 AM, Markus Armbruster wrote: >> John Snow writes: >> >>> A precise style guide and a package-wide overhaul is forthcoming pending >>> further discussion and consensus. At present, we are avoiding obvious >>> errors that cause sphinx documentation build problems. >>> >>> A preliminary style guide is loosely based on PEP 257 and Sphinx >>> Autodoc. It is chosen for interoperability with our existing Sphinx >>> framework, and because it has loose recognition in the Pycharm IDE. >>> >>> - Use Triple-double quotes ("""). >>> - Opening and closing quotes appear on their own lines for multi-line docs. >>> - A single-sentence summary should be the first line of the docstring. >>> - A blank line follows. >>> - Further prose, if needed, is written next and can be multiple paragraphs, >>> contain RST markup, etc. >>> - The :param x: desc, :returns: desc, and :raises z: desc info fields follow. >> Mandatory when they apply? >> > > Subject of debate... > > - Some people really hate obvious docstring comments. > - Some people really like the consistency. > > Which type of developer am I? Guess it depends on when you ask. > > Figured we'd hash that out when I go to write a style guide document. Fair enough. If I stop reading after the first paragraph, the patch matches expectations built by the commit message. If I speed-read, the first paragraph barely registers, but the second makes me slow down, giving me the mistaken idea that this patch is about converting to a preliminary style guide. It's not, it's about getting Sphinx errors out of the way. I figure you didn't stop after the first paragraph because you felt a need to explain why you resolve the "obvious errors" the way you do. Perhaps: qapi: modify docstrings to be sphinx-compatible A precise style guide and a package-wide overhaul is forthcoming pending further discussion and consensus. For now, merely avoid obvious errors that cause Sphinx documentation build problems, using a style loosely based on PEP 257 and Sphinx Autodoc. It is chosen for interoperability with our existing Sphinx framework, and because it has loose recognition in the Pycharm IDE. [...] >>> - Additional examples, diagrams, or other metadata follows below. >>> >>> See also: >>> >>> https://www.python.org/dev/peps/pep-0257/ >>> https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists Blank line here, by convention. >>> Signed-off-by: John Snow >>> --- >>> scripts/qapi/gen.py | 6 ++++-- >>> scripts/qapi/parser.py | 1 + >>> 2 files changed, 5 insertions(+), 2 deletions(-) >>> >>> diff --git a/scripts/qapi/gen.py b/scripts/qapi/gen.py >>> index ca66c82b5b8..dc7b94aa115 100644 >>> --- a/scripts/qapi/gen.py >>> +++ b/scripts/qapi/gen.py >>> @@ -154,9 +154,11 @@ def _bottom(self): >>> @contextmanager >>> def ifcontext(ifcond, *args): >>> - """A 'with' statement context manager to wrap with start_if()/end_if() >>> + """ >>> + A with-statement context manager that wraps with `start_if()` / `end_if()`. >>> - *args: any number of QAPIGenCCode >>> + :param ifcond: A list of conditionals, passed to `start_if()`. >>> + :param args: any number of `QAPIGenCCode`. >>> Example:: >>> diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py >>> index 9d1a3e2eea9..31bc2e6dca9 100644 >>> --- a/scripts/qapi/parser.py >>> +++ b/scripts/qapi/parser.py >>> @@ -381,6 +381,7 @@ def append(self, line): >>> The way that the line is dealt with depends on which >>> part of >>> the documentation we're parsing right now: >>> + >>> * The body section: ._append_line is ._append_body_line >>> * An argument section: ._append_line is ._append_args_line >>> * A features section: ._append_line is ._append_features_line >> I'm asking because you're not adding :param line: here. >> > > Yeah, it's not necessary to test the syntax of what else I've written > with sphinx, so I didn't add it. VERY TECHNICALLY this blurb isn't > required at all and could be deleted. You can do so if you'd like; it > will just show up later in some other patch or series more designed to > fix formatting. I recommend (but do not demand) to strictly limit this commit to "avoiding obvious errors that cause sphinx documentation build problems." >> Same for several other functions in this file. >> In schema.py: >> class QAPISchemaMember: >> """ Represents object members, enum members and features """ >> Are the spaces next to """ okay? >> > > Ideally cleaned up, but that's not a goal of this patch or series. Got it.