From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Philippe Vaucher Newsgroups: gmane.emacs.devel Subject: Re: Prefixed manual describe-function and api overview Date: Fri, 5 Jun 2020 09:55:08 +0200 Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="44264"; mail-complaints-to="usenet@ciao.gmane.io" To: Richard Stallman , Emacs developers Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Jun 05 09:56:06 2020 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1jh7Cw-000BOT-2h for ged-emacs-devel@m.gmane-mx.org; Fri, 05 Jun 2020 09:56:06 +0200 Original-Received: from localhost ([::1]:40116 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jh7Cv-0005jS-4v for ged-emacs-devel@m.gmane-mx.org; Fri, 05 Jun 2020 03:56:05 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56600) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jh7CU-0005JP-2U for emacs-devel@gnu.org; Fri, 05 Jun 2020 03:55:38 -0400 Original-Received: from mail-lj1-x234.google.com ([2a00:1450:4864:20::234]:36083) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jh7CT-0000IU-3e; Fri, 05 Jun 2020 03:55:37 -0400 Original-Received: by mail-lj1-x234.google.com with SMTP id a25so10581152ljp.3; Fri, 05 Jun 2020 00:55:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to; bh=MRfwBk/xn9kYsOOegpcm2+lFkPFAS5v0uhhLFz5DNek=; b=IWih3xBsL9uCr445xoJum/wQNTYvKI/vXTVJ24zPRWK4jA6vX8OqJ2kjaW0SDJRGG+ KmFh58+AA8GPSoHBpSDazK0flRFFq7A+FVgxzWiswCbyuiHRG6BfIIow3maXltkm8lt0 U6PPehuv+XDBe8T4YXq8CdYtDEDxkrxhlS/5Ap71OdkdPC/0NrJQN8mExvlq1txdh/gK k++Lm+N4HTFejYSBWw73yzjzQUXk8xYY/nZWYb28/u2vlr5qWBluQOOtX4d7Ytp6YQ83 mS2xLh0vp3kNCcNz7cWbzSB/XbDHE7wxooYF35hmLjTcKd9oOgj3O+VVwfYGjSNIIHzk p0Yw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to; bh=MRfwBk/xn9kYsOOegpcm2+lFkPFAS5v0uhhLFz5DNek=; b=Crf8pYOPMnk3EcGY1sIBkSOQY9fweBdfQIRlSIjm1VM3LJKHy6KWNFin0POTA9T3wR sGKZL2n7AA1mFGEQYxB7xK24lsBGtWyPvqhuMa4aY5XPOxS57NR9ho6h2Z/kw5UDOjeB g7iwNPhK9UKaZNi3N7wtEm0JMwaQo7mcsdwgNaYTEd9LbL9Ap4avsBUHBD/qWVo+eMIT rYCbznCE+SSnZBYuLkvTY7U3+7E24y38vBXuukwqdv9tsCPdTG9led1kT7ztMqCTf9AD APOrn94MGiwnm8KccPn5HLTw6B+za4b91demBfo/uFeEv575F6FqgpoAvR+DYG6P71/u Btyw== X-Gm-Message-State: AOAM531RUHj3X/tTUogSdkxsCccbQ659XoPcJVsx0RcpwQqSUg+riW/2 5lLsXCr6SAG5RAYXtrtjy8q9/L73z9tzuAk+NmllFNp4 X-Google-Smtp-Source: ABdhPJw0ZJRMHLNsliXwQjrn8CJBmh4u78V36FrAkOzaF8jvwS9EmWGEfQGMiE8kXsvISor1iMeFv7ofyPy/6p58waA= X-Received: by 2002:a2e:8246:: with SMTP id j6mr3982340ljh.54.1591343734451; Fri, 05 Jun 2020 00:55:34 -0700 (PDT) In-Reply-To: Received-SPF: pass client-ip=2a00:1450:4864:20::234; envelope-from=philippe.vaucher@gmail.com; helo=mail-lj1-x234.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: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:251882 Archived-At: > > Following up on our previous discussions, here is a working > > implementation of the completion mechanism based on the manual: > > Could you tell me in 6 lines what it does? Right sorry, I should have said it anyway. I added the mailing list for others to have my description as well. There are several function, but the one I mainly want to show you guys is `prefixed-manual-describe-function`. It is like `describe-function` (C-h f), but before you get to select a function you have to select a "topic" first. The topics are the clickable links at https://www.gnu.org/software/emacs/manual/html_node/elisp/index.html#Top. Once you select a topic, then you get to select a function but your choices are limited to the functions of said topic. This simulates the experience you get when you have a consistently prefixed api. If you want to get a quick overview, please eval the following code and select "Strings and Characters" for the topic (the example is hardcoded to propose string functions): (let ((topic (completing-read "Topic: " '("Introduction" "Lisp Data Types" "Numbers" "Strings and Characters" "Lists" "Sequences Arrays Vectors" "Records" "Hash Tables" "Symbols" "Evaluation" "Control Structures"))) (function (intern (completing-read "Function: " '("stringp" "string-or-null-p" "char-or-string-p" "make-string" "string" "substring" "substring-no-properties" "concat" "split-string" "store-substring" "clear-string" "char-equal" "string" "string-equal" "string-collate-equalp" "string" "string-lessp" "string-greaterp" "string-collate-lessp" "string-version-lessp" "string-prefix-p" "string-suffix-p" "compare-strings" "assoc-string" "number-to-string" "string-to-number" "char-to-string" "string-to-char" "format" "format-message" "downcase" "upcase" "capitalize" "upcase-initials" "case-table-p" "set-standard-case-table" "standard-case-table" "current-case-table" "set-case-table" "set-case-syntax-pair" "set-case-syntax-delims" "set-case-syntax" "describe-buffer-case-table"))))) (describe-function function)) Kind regards, Philippe