From 8e8661cdec32188a7bb108bde0d3e82eafd6a8b1 Mon Sep 17 00:00:00 2001 From: egberts Date: Fri, 5 Jul 2024 09:46:27 -0500 Subject: [PATCH] Test it using `help(pelican)` Setting terminal screen to 80x24, test the docstring using: python -c "import pelican;help(pelican)" Tiny adjustments to ensure that all comment lines are under 70-columns. --- pelican/__init__.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/pelican/__init__.py b/pelican/__init__.py index 5b6f9fe3..8cf765ba 100644 --- a/pelican/__init__.py +++ b/pelican/__init__.py @@ -11,7 +11,8 @@ that can be served via any web server or hosting service. You can perform the following functions with Pelican: -* Compose content in Markdown or reStructuredText using your editor of choice +* Compose content in Markdown or reStructuredText using your + editor of choice * Simple command-line tool (re)generates HTML, CSS, and JS from your source content * Easy to interface with version control systems and web hooks @@ -19,7 +20,8 @@ You can perform the following functions with Pelican: Pelican features main highlights include: -* Chronological content (e.g., articles, blog posts) as well as static pages +* Chronological content (e.g., articles, blog posts) as + well as static pages * Integration with external services * Site themes (created using Jinja2 templates) * Publication of articles in multiple languages @@ -117,7 +119,7 @@ class Pelican: signals.initialized.send(self) def init_path(self): - """Add this path to the Python builtin/system module search path, if missing. + """Add a path to Python system module search path, if missing. :param self: implicit Pelican class scope :type self: class @@ -823,7 +825,8 @@ def listen(server, port, output, excqueue=None): :type server: str :param port: port number to listen on. (`PORT`) :type port: str - :param output: the CLI arguments provided by the main routine (`OUTPUT_PATH`) + :param output: the CLI arguments provided by the main + routine (`OUTPUT_PATH`) :type output: str :param excqueue: Function of execution queue handler to use :type excqueue: Method