From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id SA/2NKW/1mIdQQAAbAwnHQ (envelope-from ) for ; Tue, 19 Jul 2022 16:28:53 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id GMXZNKW/1mK5XQEA9RJhRA (envelope-from ) for ; Tue, 19 Jul 2022 16:28:53 +0200 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 ACF662C7DA for ; Tue, 19 Jul 2022 16:23:56 +0200 (CEST) Received: from localhost ([::1]:47652 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oDo8h-0000LO-OI for larch@yhetil.org; Tue, 19 Jul 2022 10:23:55 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49928) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oDnj2-0000dM-HR for emacs-orgmode@gnu.org; Tue, 19 Jul 2022 09:57:24 -0400 Received: from mail-pg1-x533.google.com ([2607:f8b0:4864:20::533]:41888) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oDnj0-0003oJ-Uz for emacs-orgmode@gnu.org; Tue, 19 Jul 2022 09:57:24 -0400 Received: by mail-pg1-x533.google.com with SMTP id 23so13534117pgc.8 for ; Tue, 19 Jul 2022 06:57:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:in-reply-to:references:date:message-id :mime-version; bh=guubghz/4aryToos4EZEBQNGlkJ1Z2HCOrmKhm8O/Dg=; b=YM+8A2IQyGpaaBVuNa2wwVQI8bNTxQDbkegqSs1eInXaggiC0SRzPmd/PF5O5C338L vrLjPRsN4PQkcDBI8o7obKyqCrM+erl0kYpLKMFvSdmbS7qkRaXokSRa6rzCgr+Qmjuj yQnMmn7JuNzNXioSEAludfXPja8XUimmzMuisCgw/SBgX+lY8o6tF0Qt0qI+8CrTMc62 0hiUQ1+0mk3/lAELfmsg+AilVKnH4Y03ZkfYA9SYL1e0e0w5iBoNZWedPFejN6SxGIAU FnCoJXQYh3KwDvTCRFOOdHyZd+bhKns/2E0QqiuE5sAVDgX7UcDMywqzcaaStlAmP5vG MXxw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:in-reply-to:references:date :message-id:mime-version; bh=guubghz/4aryToos4EZEBQNGlkJ1Z2HCOrmKhm8O/Dg=; b=QxFWYXpNU4nURNpxXRrqS1let7nJpEmpVXtTz8IB5LCUjFi0P6QJhTI/1Y3ItA33Cf 25tX1dtHk+XWEwwIdnxBItw4o5GiKQrjcIKKiXN9MHx2cxSb28WPBMlrp8J3te1Gwnle XKp3LxDORnVZqqYSshp1jdt66kq3aJH1pJklaPjO+yvSiFhXnux3g1W56MkTgLpgnE0y vAq5u3ZgNZuEFCTDz97cJWwZJrfT8lyjsdR5mGaO5oH5FQh0xPHtFG2zClLNCkyMzKf5 HXi+A9hCiRPhw5/gLUrwKvhc8aUi309yPLY0FDWvqsfISvHkmA0jf+f6W2N+9T7m8Uya ldjg== X-Gm-Message-State: AJIora9IkV5Lk19peHaAF3no4NUleqbgR5uTJ6euWU4ozQtN7OIVoIWo ph5Wjnut0jIqBOWsoz5guBhfIWFk1xAMkw== X-Google-Smtp-Source: AGRyM1tHKLyR+XrYVyAZpP9q5v1uz2EAsKat56qQQzP7UocZ0ytZM8tabHgc/y7ntX6mHp6zKq0MHg== X-Received: by 2002:a65:5b44:0:b0:412:b6dc:7076 with SMTP id y4-20020a655b44000000b00412b6dc7076mr28556720pgr.601.1658239041592; Tue, 19 Jul 2022 06:57:21 -0700 (PDT) Received: from localhost ([2409:8a70:2b7:3fb0:8ec6:81ff:fe70:339d]) by smtp.gmail.com with ESMTPSA id s13-20020a170902b18d00b0016bfb09be10sm11633048plr.305.2022.07.19.06.57.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 19 Jul 2022 06:57:20 -0700 (PDT) From: Ihor Radchenko To: Yuchen Pei Cc: emacs-orgmode mailing list , haskell-cafe Subject: Re: An org backend to Haddock In-Reply-To: <87k08azl1d.fsf@ypei.me> References: <87k08azl1d.fsf@ypei.me> Date: Tue, 19 Jul 2022 21:58:26 +0800 Message-ID: <87sfmx4325.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=2607:f8b0:4864:20::533; envelope-from=yantar92@gmail.com; helo=mail-pg1-x533.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 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_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1658240636; h=from:from:sender:sender: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:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=guubghz/4aryToos4EZEBQNGlkJ1Z2HCOrmKhm8O/Dg=; b=uWbFAtoyKh7ySrx87H4Boze5MHXhzU1ufgMz7ZNhnAQ6fhUhwrIKmvDx30Ad1wd4QMzBaj 0WmwskBU29kI5cglMPYH283jA1pwKZHHwUqDq2c7u1dHTCE0fpvjbP1GLidb83IK+fCO6E orYG4RcvAW7Ivoj1V4k2Lna7ikaoZ+d1bYz32T2y/IKWV1aED7cc8NQPAmDArxuyY4Gmkb 3yLv+cIkkMzVB2fMdSOE7AAizsW9mMxbeZ9oCgqWOpKQmqjppbeX8l6AC1UomRsWNoIyfJ uYjyl9jLocCLGP6+Ldxzm7UyvWHBIKPoOXkW9/aIo/V7ddgCJabn8XN/Nz+KZg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1658240636; a=rsa-sha256; cv=none; b=nlj/ukNVI93RLZBaui7ZlyNq1C0O7hc18atSPeNHeKTD7XT4sjGsu1+dH/NUCnH7f3hOBh WCkkHzDmqy1Cyx4NfMHa/Ei21y80uJAhj4BBTmVyN/hulEi2NxiKyewSI7zNG9abkeJt+N 8WRvSzBj0Fo3C/lpDDVZP91d1JXdM/BIePRb07odYyaU5rRAFJzg50zyjz1Vti7nCRIZKw 0RVW/Kl0LW54c3kVmTDXjnZ0IrbKOZI82/BxJjgFrsmMPdRdDkS+mkGX4yWFkD772/nvWO E1KCXd1YCIB1j+0bCyKefne2iqSvDRfOsQAOM0rz3vOwga+mfkdKGe9MYzy1bQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=YM+8A2IQ; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -8.93 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=YM+8A2IQ; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: ACF662C7DA X-Spam-Score: -8.93 X-Migadu-Scanner: scn0.migadu.com X-TUID: Y7tPcSS7HTc5 Yuchen Pei writes: > Given this is not the official version of haddock and my changes are in > haddock-api, I'm calling it haddorg-api, for lack of a better name / > approach. I'll be happy to contribute my changes upstream if a > different license covering my contribution (AGPLv3+) is accepted. > > Let me know what you think. I am pretty sure that you are asking the Haskell people for upstreaming ;) >From Org side, it is always welcome when other Free software projects are making use of Org. Also, I looked into https://g.ypei.me/haddock.git/tree/haddock-api/src/Haddock/Backends/Org/Types.hs Beware of possible edge cases with "*/~|" in formatting. I am not sure if text containing such symbols is possible as an input for your library, but if it is, things may get formatted wrongly. For example, text containing "|" anywhere inside a table field must have "|" escaped using \vert entity. The markup can be escaped using zero-width space. Best, Ihor