From mboxrd@z Thu Jan 1 00:00:00 1970 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=-6.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_1 autolearn=no 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 6A39EC4727C for ; Wed, 30 Sep 2020 17:40:02 +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 940F320706 for ; Wed, 30 Sep 2020 17:40:00 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="R0cnpslu" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 940F320706 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]:53540 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kNg59-0000lz-5E for qemu-devel@archiver.kernel.org; Wed, 30 Sep 2020 13:39:59 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:52758) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kNg3n-00082F-5T for qemu-devel@nongnu.org; Wed, 30 Sep 2020 13:38:35 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:48903) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kNg3j-0003Y4-Ft for qemu-devel@nongnu.org; Wed, 30 Sep 2020 13:38:34 -0400 Dkim-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1601487508; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Fpy+xyOrmfyHRDvRUNg80l0cRy89IiiW1eGESrTbvA0=; b=R0cnpsluXUh1rQ+jM6/VBS5MEoZWLSseE71dmL1jJaY5NcBtNT80DG0sKup8v50LHpEadj piJPwjID88LfgAryqlIu33YBpY+IeW5T3taHLSbosfwFaSWooR8bV4qlSqW+AiVrSFaTR2 9AFtCR6/VFqeVdweeOPo6M+NkCtvyPc= 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-337-gdMtvUVlOfCKS5GqICMjNw-1; Wed, 30 Sep 2020 13:38:26 -0400 X-MC-Unique: gdMtvUVlOfCKS5GqICMjNw-1 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 943F31019638; Wed, 30 Sep 2020 17:38:25 +0000 (UTC) Received: from [10.10.119.140] (ovpn-119-140.rdu2.redhat.com [10.10.119.140]) by smtp.corp.redhat.com (Postfix) with ESMTP id 46A4D5D9E2; Wed, 30 Sep 2020 17:38:24 +0000 (UTC) Subject: Re: [PATCH v4 04/46] qapi: modify docstrings to be sphinx-compatible To: Markus Armbruster References: <20200930043150.1454766-1-jsnow@redhat.com> <20200930043150.1454766-5-jsnow@redhat.com> <87wo0bejmy.fsf@dusky.pond.sub.org> From: John Snow Message-ID: <4bb15cb7-ddcc-ae41-dcb8-81aaa7117ffa@redhat.com> Date: Wed, 30 Sep 2020 13:38:23 -0400 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.11.0 MIME-Version: 1.0 In-Reply-To: <87wo0bejmy.fsf@dusky.pond.sub.org> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=jsnow@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Received-SPF: pass client-ip=216.205.24.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/09/30 00:26:33 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.469, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, NICE_REPLY_A=-0.001, 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: Peter Maydell , Thomas Huth , Eduardo Habkost , qemu-devel@nongnu.org, Cleber Rosa , =?UTF-8?Q?Alex_Benn=c3=a9e?= Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" On 9/30/20 4:47 AM, Markus Armbruster wrote: > Sadly, the fact that start_if() and end_if() are functions isn't > immediately obvious anymore. > > I've seen :func:`start_if` elsewhere. Is this something we should or > want to use? Looks like `start_if()` works just fine too. If you are hard-set in wanting to see those parentheses I can use this style, but admit I am not likely to use them myself in newer docstrings, and there's no way to enforce their presence OR absence that I am aware of. I'll bake that change in for now until I see another reply. --js