openscad/BOSL2
1
0
Fork 0
mirror of https://github.com/revarbat/BOSL2.git synced 2025-08-07 07:56:42 +02:00
Code Issues Projects Releases Wiki Activity

Improved documentation generation for arguments.

Browse Source
This commit is contained in:
Garth Minette
2021-01-23 14:41:06 -08:00
parent 9fc753ec8d
commit 678dce5796
2 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
scripts/docs_gen.py
View File

@@ -574,12 +574,13 @@ class LeafNode(object):
for line in block: for line in block:
out.append(mkdn_esc(line)) out.append(mkdn_esc(line))
out.append("") out.append("")
if self.arguments: if self.arguments or self.named_arguments:
out.append("**Arguments:**") out.append("**Arguments:**")
if self.arguments:
out.append('<abbr title="These args can be used by position or by name.">By&nbsp;Position</abbr> | What it does') out.append('<abbr title="These args can be used by position or by name.">By&nbsp;Position</abbr> | What it does')
out.append("---------------- | ------------------------------") out.append("---------------- | ------------------------------")
for argname, argdesc in self.arguments: for argname, argdesc in self.arguments:
argname = argname.replace(" / ", "` / `") argname = " / ".join("`{}`".format(x.strip()) for x in argname.replace("|","/").split("/"))
out.append( out.append(
"{0:15s} | {1}".format( "{0:15s} | {1}".format(
"`{0}`".format(argname), "`{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&nbsp;Name</abbr> | What it does') out.append('<abbr title="These args must be used by name, ie: name=value">By&nbsp;Name</abbr> | What it does')
out.append("-------------- | ------------------------------") out.append("-------------- | ------------------------------")
for argname, argdesc in self.named_arguments: for argname, argdesc in self.named_arguments:
argname = argname.replace(" / ", "` / `") argname = " / ".join("`{}`".format(x.strip()) for x in argname.replace("|","/").split("/"))
out.append( out.append(
"{0:15s} | {1}".format( "{0:15s} | {1}".format(
"`{0}`".format(argname), "`{0}`".format(argname),

2
version.scad
View File

@@ -6,7 +6,7 @@
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
BOSL_VERSION = [2,0,538]; BOSL_VERSION = [2,0,539];
// Section: BOSL Library Version Functions // Section: BOSL Library Version Functions