From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id oIoAB1mC2l5iJgAA0tVLHw (envelope-from ) for ; Fri, 05 Jun 2020 17:35:21 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id ZuC0AlmC2l5MawAAbx9fmQ (envelope-from ) for ; Fri, 05 Jun 2020 17:35:21 +0000 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 aspmx1.migadu.com (Postfix) with ESMTPS id C6F22940983 for ; Fri, 5 Jun 2020 17:35:20 +0000 (UTC) Received: from localhost ([::1]:52446 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jhGFT-0001P5-PC for larch@yhetil.org; Fri, 05 Jun 2020 13:35:19 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:47822) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jhGFK-0001OF-PU for guix-devel@gnu.org; Fri, 05 Jun 2020 13:35:10 -0400 Received: from mail-qk1-x72c.google.com ([2607:f8b0:4864:20::72c]:40043) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jhGFJ-0003IL-U1; Fri, 05 Jun 2020 13:35:10 -0400 Received: by mail-qk1-x72c.google.com with SMTP id c185so10495246qke.7; Fri, 05 Jun 2020 10:35:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:from:date:message-id:subject:to :content-transfer-encoding; bh=ADzu511ZuXzaUXwmEaueGyy9v3DGsnuzXaf64S2ic5E=; b=CLfobc+ebqEgNh8e3Lzhbi3DHdzaedXWWkgFKSbT6r9grrJRCYqswFkFk3VsjjjZYB zwPsBbzgzeXEQKS5/zjGARtOPI4IOPhx3N9QSGEaqKbY15aYeOuo3o2iwHpDcC7QIk2O 3rCYCv+UwpH3qlr6eU2f+jULL5A7qwjSWSUrEKsPcrJM0NK3F1moKUlrfhFD/Y2LPGlL 2iThdvBxrKRPBV4zRHG/3kRtp6ofr0D5TUkFKqEC6rqaut+QWHv6kNxmzPMI4QSE0RxB zl/oI+3+OL9OFBuc31nkRrXD3KRw5mXQqJoFK7rtw1ixlvTXzsECLk2vP42x2d7QrOgT 1D3g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to :content-transfer-encoding; bh=ADzu511ZuXzaUXwmEaueGyy9v3DGsnuzXaf64S2ic5E=; b=ZFBEblA8Q/8phu5tAVYe00XmPOnGqs52CY/aaOuDTl3HdZzDDFlZD+6VLOnzqFRxYE TIZY9XBej29436q6ZKAVq8q/2Ay6nJTXQzwDrgAFI2Q329+kricWRz2VzHw+/XqoiL8G ZdD/zUJcztR3jQhruHPAqUnojVeH14aeQoCMiVEQ6G4V4ftValvHYcmOtZ91T+N2y8aU TqU6FIq27W+WK2ny+sHt7gukFO+UV5g/IKpu9PPnDJWfakX5gMxxzuAw8XJVJGlgE3Oh SuGx7wclrKBLtKJJDRgU3qpd3/hko9xniuendP6gOCwH69vYcGLL2IyzQEdmx84NFMgZ Bviw== X-Gm-Message-State: AOAM533Xp3DXSgmcgdfhsS8QdoO+FbvHcJ9f0uIYfDwbfvfVD4KYwDP2 R2ciIMGPcyNdge+J5QbHxpyv+puY9qLGBdWGKMaWbKqu X-Google-Smtp-Source: ABdhPJy/9vjJ9T7IL0BtNRQVRDa6NePu0WrG0PohM0nfrQWT3JjitOdOm1VlIbOKb1Kbffw5X9rG89Vmwp1st/ZA4FE= X-Received: by 2002:a37:73c7:: with SMTP id o190mr2373140qkc.232.1591378508552; Fri, 05 Jun 2020 10:35:08 -0700 (PDT) MIME-Version: 1.0 From: zimoun Date: Fri, 5 Jun 2020 19:34:57 +0200 Message-ID: Subject: Manual consistency To: =?UTF-8?Q?Ludovic_Court=C3=A8s?= , Konrad Hinsen , Guix Devel Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass client-ip=2607:f8b0:4864:20::72c; envelope-from=zimon.toutoune@gmail.com; helo=mail-qk1-x72c.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001 autolearn=_AUTOLEARN X-Spam_action: no action X-BeenThere: guix-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+larch=yhetil.org@gnu.org Sender: "Guix-devel" X-Scanner: scn0 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20161025 header.b=CLfobc+e; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of guix-devel-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-devel-bounces@gnu.org X-Spam-Score: -1.71 X-TUID: rAjwiTuSSvjy Hi Ludo, (from: http://issues.guix.gnu.org/issue/41253#10) On Fri, 5 Jun 2020 at 18:36, Ludovic Court=C3=A8s wrote: > > There are many examples in guix.texi with $, and also many without. Plu= s > > some with # as the command line prompt. > > Yeah, the manual is kinda inconsistent, and I=E2=80=99m self-inconsistent= to > tell the truth. :-) > > I=E2=80=99ve come to the conclusion that snippets that contain only input= should > be written without a prompt, for easier copy/pasting. > > (I=E2=80=99ve seen Python documentation where JS magic allows people to t= oggle > prompt display, I find it nice.) I propose to do a pass on that: - apply this rule: no-$ for only input and $ to distinguish between inputs and outputs. - backtick ` replaced by $(...) as discussed elsewhere and then send a "Fix typo" patch. And maybe add a bullet in the Contributing Section. WDYT? All the best, simon