tree: checkdoc

phobos.el

@@ -1,4 +1,4 @@
-;;; phobos.el --- view Phobos documentation from within Emacs  -*- lexical-binding:t -*-
+;;; phobos.el --- view Phobos documentation  -*- lexical-binding:t -*-
 
 ;; Copyright (C) 2024 Jeremy Baxter
 
@@ -25,7 +25,7 @@
 ;;; Commentary:
 
 ;; phobos.el provides several functions for viewing Phobos documentation
-;; and documentation for other D libraries. These functions open the
+;; and documentation for other D libraries.  These functions open the
 ;; documentation in a web browser, calling the process `phobos-browser'.
 
 ;; These functions are provided:
@@ -55,6 +55,7 @@
   :type 'string)
 
 (defun phobos--visit (&rest format-args)
+  "Call `format' with FORMAT-ARGS and pass the result to a web browser."
   (let ((url (apply #'format format-args)))
     (shell-command (concat phobos-browser " " url))
     (message url)))
@@ -67,7 +68,7 @@ SYMBOL 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
+Phobos is the standard library for the D programming language.  For more
 information on Phobos and the D programming language, see <https://dlang.org>."
   (interactive "MModule or symbol: ")
   (phobos--visit "%s/%s.html" phobos-root (string-replace "." "/" symbol)))
@@ -77,7 +78,7 @@ information on Phobos and the D programming language, see <https://dlang.org>."
   "View the documentation on SYMBOL from the dub package PACKAGE.
 
 PACKAGE is the name of a package listed on the code.dlang.org registry.
-For more information on SYMBOL, see the documentation for `phobos'. If
+For more information on SYMBOL, see the documentation for `phobos'.  If
 SYMBOL is not provided, the contents of PACKAGE is displayed instead.
 
 Support for dub package documentation is provided by Adam Ruppe's