From 678dce579665f19f54f3bf39358987d3aa3e27ee Mon Sep 17 00:00:00 2001 From: Garth Minette <gminette@gmail.com> Date: Sat, 23 Jan 2021 14:41:06 -0800 Subject: [PATCH] Improved documentation generation for arguments. --- scripts/docs_gen.py | 7 ++++--- version.scad | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/scripts/docs_gen.py b/scripts/docs_gen.py index fc0afa7..71a4aa1 100755 --- a/scripts/docs_gen.py +++ b/scripts/docs_gen.py @@ -574,12 +574,13 @@ class LeafNode(object): for line in block: out.append(mkdn_esc(line)) out.append("") - if self.arguments: + if self.arguments or self.named_arguments: out.append("**Arguments:**") + if self.arguments: out.append('<abbr title="These args can be used by position or by name.">By Position</abbr> | What it does') out.append("---------------- | ------------------------------") for argname, argdesc in self.arguments: - argname = argname.replace(" / ", "` / `") + argname = " / ".join("`{}`".format(x.strip()) for x in argname.replace("|","/").split("/")) out.append( "{0:15s} | {1}".format( "`{0}`".format(argname), @@ -591,7 +592,7 @@ class LeafNode(object): out.append('<abbr title="These args must be used by name, ie: name=value">By Name</abbr> | What it does') out.append("-------------- | ------------------------------") for argname, argdesc in self.named_arguments: - argname = argname.replace(" / ", "` / `") + argname = " / ".join("`{}`".format(x.strip()) for x in argname.replace("|","/").split("/")) out.append( "{0:15s} | {1}".format( "`{0}`".format(argname), diff --git a/version.scad b/version.scad index 3249640..6886ffb 100644 --- a/version.scad +++ b/version.scad @@ -6,7 +6,7 @@ ////////////////////////////////////////////////////////////////////// -BOSL_VERSION = [2,0,538]; +BOSL_VERSION = [2,0,539]; // Section: BOSL Library Version Functions