From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#32359: [PATCH] Add svg-path Date: Fri, 03 Aug 2018 16:05:08 +0300 Message-ID: <83zhy3txbv.fsf@gnu.org> References: NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1533301479 9757 195.159.176.226 (3 Aug 2018 13:04:39 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 3 Aug 2018 13:04:39 +0000 (UTC) Cc: 32359@debbugs.gnu.org To: "Felix E. Klee" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Aug 03 15:04:35 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1flZkw-0002Pj-Dt for geb-bug-gnu-emacs@m.gmane.org; Fri, 03 Aug 2018 15:04:34 +0200 Original-Received: from localhost ([::1]:50968 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1flZn0-0005cm-M7 for geb-bug-gnu-emacs@m.gmane.org; Fri, 03 Aug 2018 09:06:44 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:53880) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1flZmP-0005LN-Dz for bug-gnu-emacs@gnu.org; Fri, 03 Aug 2018 09:06:11 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1flZmM-0000Fg-OX for bug-gnu-emacs@gnu.org; Fri, 03 Aug 2018 09:06:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:34609) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1flZmM-0000FV-KK for bug-gnu-emacs@gnu.org; Fri, 03 Aug 2018 09:06:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1flZmM-0005Fi-85 for bug-gnu-emacs@gnu.org; Fri, 03 Aug 2018 09:06:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 03 Aug 2018 13:06:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 32359 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 32359-submit@debbugs.gnu.org id=B32359.153330152919911 (code B ref 32359); Fri, 03 Aug 2018 13:06:02 +0000 Original-Received: (at 32359) by debbugs.gnu.org; 3 Aug 2018 13:05:29 +0000 Original-Received: from localhost ([127.0.0.1]:39627 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1flZlo-0005B4-RI for submit@debbugs.gnu.org; Fri, 03 Aug 2018 09:05:29 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:34546) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1flZln-0005A2-2k for 32359@debbugs.gnu.org; Fri, 03 Aug 2018 09:05:27 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1flZlf-0008R5-4v for 32359@debbugs.gnu.org; Fri, 03 Aug 2018 09:05:21 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:47476) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1flZle-0008Qp-SW; Fri, 03 Aug 2018 09:05:19 -0400 Original-Received: from [176.228.60.248] (port=2540 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1flZle-0007aK-8b; Fri, 03 Aug 2018 09:05:18 -0400 In-reply-to: (felix.klee@inka.de) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:149232 Archived-At: > From: "Felix E. Klee" > Date: Fri, 3 Aug 2018 13:07:42 +0200 > > The patch adds `svg-path'. Among other things, this function makes it > possible to add arcs to SVG images. A path is drawn using commands > defined by the SVG standard: > > https://www.w3.org/TR/SVG11/paths.html#PathData Thanks. This contribution can be accepted without legal paperwork, but the next one will need a copyright assignment, so I'd encourage you to start your paperwork now. A few comments, mainly about the documentation parts. > diff --git a/ChangeLog.3 b/ChangeLog.3 > index a0a4794b4e..2a9832b67b 100644 > --- a/ChangeLog.3 > +++ b/ChangeLog.3 > @@ -1,3 +1,7 @@ > +2018-08-03 Felix E. Klee > + > + * lisp/svg.el (svg-path): New function. > + We don't maintain a ChangeLog file; the above should be the commit log message. > +@defun svg-path svg commands &rest args > +Add the outline of a shape to @var{svg}. The @var{commands} follow the > +Scalable Vector Graphics standard. This function can be used to create > +arcs. This is too cryptic for the manual, and the example doesn't help enough. We should at least explain what "arcs" means in this context, and in general what is this function about; also what kind of object is SCG. Also, please observe our standard of having 2 spaces between sentences. In general, GNU Coding Standards frown upon using "path" for anything that is not PATH-style directory lists, so maybe use a different name or explain what kind of "path" is being referenced here. E.g., the Web page to which you pointed does include a definition of "path" in this context. > +(defun svg-path (svg commands &rest args) > + "Add the outline of a shape to SVG. The COMMANDS follow the > +Scalable Vector Graphics standard. This function can be used to > +create arcs." The first line of the doc string should be a single complete sentence, and it should mention all of the arguments. Also, please keep 2 spaces between sentences in the doc strings. I also think the doc string should say that COMMANDS are strings, or objects whose printed representation yields valid SVG commands. This new function should also be announced in NEWS.