From decfe0dc9cb3f3788bb35acc289717eb37cd92a3 Mon Sep 17 00:00:00 2001 From: Jeremy Baxter Date: Wed, 17 Jul 2024 17:12:49 +1200 Subject: [PATCH] phobos.el: improve documentation --- phobos.el | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/phobos.el b/phobos.el index 179e472..be1bcc0 100644 --- a/phobos.el +++ b/phobos.el @@ -24,16 +24,19 @@ ;;; Code: (defvar phobos-browser "xdg-open" - "Web browser to use when opening Phobos documentation.") + "Web browser to use when opening documentation with `phobos'.") (defvar phobos-root "https://dlang.org/library" - "Root URL to use when viewing Phobos documentation.") + "Root URL to use when viewing documentation with `phobos'.") (defun phobos (symbol-name) "View the documentation on SYMBOL-NAME from the Phobos documentation. -SYMBOL-NAME can be a module (e.g. std.algorithm), a submodule (e.g. -std.algorithm.searching), a function (e.g. std.algorithm.searching.findSplit) -or any other symbol part of a standard module, such as object.Exception." +SYMBOL-NAME can be a module (e.g. std.sumtype), a submodule (e.g. +std.algorithm.searching), a function or type (e.g. std.stdio.File) +or any other symbol part of a standard module, such as object.Exception. + +Phobos is the standard library for the D programming language. For more +information on Phobos and the D programming language, see ." (interactive "MModule or symbol: ") (shell-command (concat phobos-browser " " phobos-root "/" (string-replace "." "/" symbol-name) ".html")))