diff --git a/CHANGES b/CHANGES index 709af061..bccd46c9 100644 --- a/CHANGES +++ b/CHANGES @@ -1,4 +1,12 @@ +2.8.0-22 | 2021-05-18 13:13:17 -0700 + + * Minor docstring formatting improvements (Jon Siwek, Corelight) + + * Add 'uservar' and 'template' modules to API docs (Jon Siwek, Corelight) + + * Fix sphinxarg extension's use of old Sphinx logging API (Jon Siwek, Corelight) + 2.8.0-19 | 2021-05-18 12:03:36 -0700 * Minor developer guide tweaks (Jon Siwek, Corelight) diff --git a/VERSION b/VERSION index 300cda26..2daf9da8 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.8.0-19 +2.8.0-22 diff --git a/doc/man/zkg.1 b/doc/man/zkg.1 index 83b78df9..cf939986 100644 --- a/doc/man/zkg.1 +++ b/doc/man/zkg.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "ZKG" "1" "May 18, 2021" "2.8.0-19" "Zeek Package Manager" +.TH "ZKG" "1" "May 18, 2021" "2.8.0-22" "Zeek Package Manager" .SH NAME zkg \- Zeek Package Manager . @@ -38,8 +38,7 @@ A command\-line package manager for Zeek. .sp .nf .ft C -usage: zkg [\-h] [\-\-version] [\-\-configfile FILE | \-\-user] [\-\-verbose] [\-\-extra\-source NAME=URL] - {test,install,bundle,unbundle,remove,purge,refresh,upgrade,load,unload,pin,unpin,list,search,info,config,autoconfig,env,create,template} ... +usage: zkg [\-h] [\-\-version] [\-\-configfile FILE | \-\-user] [\-\-verbose] [\-\-extra\-source NAME=URL] {test,install,bundle,unbundle,remove,purge,refresh,upgrade,load,unload,pin,unpin,list,search,info,config,autoconfig,env,create,template} ... .ft P .fi .UNINDENT @@ -322,7 +321,7 @@ Uprades the specified package(s) to latest available version. If no specific pa .sp .nf .ft C -usage: zkg upgrade [\-h] [\-\-skiptests] [\-\-nodeps] [\-\-nosuggestions] [\-\-force] [\-\-user\-var NAME=VAL] [package ...] +usage: zkg upgrade [\-h] [\-\-skiptests] [\-\-nodeps] [\-\-nosuggestions] [\-\-force] [\-\-user\-var NAME=VAL] [package [package ...]] .ft P .fi .UNINDENT diff --git a/zeekpkg/__init__.py b/zeekpkg/__init__.py index 99585371..330eaae2 100644 --- a/zeekpkg/__init__.py +++ b/zeekpkg/__init__.py @@ -3,13 +3,13 @@ and performing other operations on Zeek Packages and Package Sources. The main entry point is the :class:`Manager ` class. -This package provides a logger named `LOG` to which logging stream handlers may -be added in order to help log/debug applications. +This package provides a logger named ``LOG`` to which logging stream handlers +may be added in order to help log/debug applications. """ import logging -__version__ = "2.8.0-19" +__version__ = "2.8.0-22" __all__ = ['manager', 'package', 'source', 'template', 'uservar'] LOG = logging.getLogger(__name__) diff --git a/zeekpkg/uservar.py b/zeekpkg/uservar.py index 9e925952..dd91927c 100644 --- a/zeekpkg/uservar.py +++ b/zeekpkg/uservar.py @@ -10,7 +10,7 @@ def slugify(string): """Returns file-system-safe, lower-case version of the input string. - Any character sequence outside of [a-zA-Z0-9_]+ gets replaced by a + Any character sequence outside of ``[a-zA-Z0-9_]+`` gets replaced by a single underscore. If the variable has no value or the value is an empty string, returns the given default. """