From abbfc92da0b68670c6e03e2944ca83bb185effa8 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Fri, 22 Apr 2022 17:05:22 -0700 Subject: [PATCH] clarify plugin filename requirements --- README.md | 6 +++--- templates/readme_template | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6b89c393..df59a3bc 100644 --- a/README.md +++ b/README.md @@ -402,9 +402,9 @@ Local parser plugins are standard python module files. Use the or [`jc/parsers/foo_s.py (streaming)`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo_s.py) parser as a template and simply place a `.py` file in the `jcparsers` subfolder. -Local plugin filenames must be valid python module names, therefore must consist -entirely of alphanumerics and start with a letter. Local plugins may override -default parsers. +Local plugin filenames must be valid python module names and therefore must +start with a letter and consist entirely of alphanumerics. Local plugins +may override default parsers. > Note: The application data directory follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) diff --git a/templates/readme_template b/templates/readme_template index 86b5d483..e3c65370 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -305,9 +305,9 @@ Local parser plugins are standard python module files. Use the or [`jc/parsers/foo_s.py (streaming)`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo_s.py) parser as a template and simply place a `.py` file in the `jcparsers` subfolder. -Local plugin filenames must be valid python module names, therefore must consist -entirely of alphanumerics and start with a letter. Local plugins may override -default parsers. +Local plugin filenames must be valid python module names and therefore must +start with a letter and consist entirely of alphanumerics. Local plugins +may override default parsers. > Note: The application data directory follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)