Profouzors
/
boxespy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add links to documentation to web UI 

for some of the parameters
This commit is contained in:
Florian Festi 2022-01-03 13:30:43 +01:00
parent 4ba1768d29
commit acf4e81159
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
boxes/__init__.py
View File

@ -278,29 +278,29 @@ class Boxes:
"Default Settings") "Default Settings")
defaultgroup.add_argument( defaultgroup.add_argument(
"--thickness", action="store", type=float, default=3.0, "--thickness", action="store", type=float, default=3.0,
help="thickness of the material") help="thickness of the material [\U0001F6C8](https://florianfesti.github.io/boxes/html/usermanual.html#thickness)")
defaultgroup.add_argument( defaultgroup.add_argument(
"--output", action="store", type=str, default="box.svg", "--output", action="store", type=str, default="box.svg",
help="name of resulting file") help="name of resulting file")
defaultgroup.add_argument( defaultgroup.add_argument(
"--format", action="store", type=str, default="svg", "--format", action="store", type=str, default="svg",
choices=self.formats.getFormats(), choices=self.formats.getFormats(),
help="format of resulting file") help="format of resulting file [\U0001F6C8](https://florianfesti.github.io/boxes/html/usermanual.html#format)")
defaultgroup.add_argument( defaultgroup.add_argument(
"--tabs", action="store", type=float, default=0.0, "--tabs", action="store", type=float, default=0.0,
help="width of tabs holding the parts in place in mm (not supported everywhere)") help="width of tabs holding the parts in place in mm (not supported everywhere)")
defaultgroup.add_argument( defaultgroup.add_argument(
"--debug", action="store", type=boolarg, default=False, "--debug", action="store", type=boolarg, default=False,
help="print surrounding boxes for some structures") help="print surrounding boxes for some structures [\U0001F6C8](https://florianfesti.github.io/boxes/html/usermanual.html#debug)")
defaultgroup.add_argument( defaultgroup.add_argument(
"--labels", action="store", type=boolarg, default=True, "--labels", action="store", type=boolarg, default=True,
help="label the parts (where available)") help="label the parts (where available)")
defaultgroup.add_argument( defaultgroup.add_argument(
"--reference", action="store", type=float, default=100, "--reference", action="store", type=float, default=100,
help="print reference rectangle with given length (zero to disable)") help="print reference rectangle with given length (zero to disable) [\U0001F6C8](https://florianfesti.github.io/boxes/html/usermanual.html#reference)")
defaultgroup.add_argument( defaultgroup.add_argument(
"--burn", action="store", type=float, default=0.1, "--burn", action="store", type=float, default=0.1,
help='burn correction in mm (bigger values for tighter fit). Use BurnTest in "Parts and Samples" to find the right value.') help='burn correction in mm (bigger values for tighter fit). Use BurnTest in "Parts and Samples" to find the right value. [\U0001F6C8](https://florianfesti.github.io/boxes/html/usermanual.html#burn)')
@contextmanager @contextmanager
def saved_context(self): def saved_context(self):
@ -403,19 +403,19 @@ class Boxes:
self.argparser.add_argument( self.argparser.add_argument(
"--sx", action="store", type=argparseSections, "--sx", action="store", type=argparseSections,
default=default, default=default,
help="""sections left to right in mm. See --sy for format""") help="""sections left to right in mm [\U0001F6C8](https://florianfesti.github.io/boxes/html/usermanual.html#section-parameters)""")
elif arg == "sy": elif arg == "sy":
if default is None: default = "50*3" if default is None: default = "50*3"
self.argparser.add_argument( self.argparser.add_argument(
"--sy", action="store", type=argparseSections, "--sy", action="store", type=argparseSections,
default=default, default=default,
help="""sections back to front in mm. Possible formats: overallwidth/numberof sections e.g. "250/5"; sectionwidth*numberofsections e.g. "50*5"; section widths separated by ":" e.g. "30:25.5:70""") help="""sections back to front in mm [\U0001F6C8](https://florianfesti.github.io/boxes/html/usermanual.html#section-parameters)""")
elif arg == "sh": elif arg == "sh":
if default is None: default = "50*3" if default is None: default = "50*3"
self.argparser.add_argument( self.argparser.add_argument(
"--sh", action="store", type=argparseSections, "--sh", action="store", type=argparseSections,
default=default, default=default,
help="""sections bottom to top in mm. See --sy for format""") help="""sections bottom to top in mm [\U0001F6C8](https://florianfesti.github.io/boxes/html/usermanual.html#section-parameters)""")
elif arg == "h": elif arg == "h":
if default is None: default = 100.0 if default is None: default = 100.0
help = "inner height in mm" help = "inner height in mm"
@ -446,7 +446,7 @@ class Boxes:
if default is None: default = True if default is None: default = True
self.argparser.add_argument( self.argparser.add_argument(
"--outside", action="store", type=boolarg, default=default, "--outside", action="store", type=boolarg, default=default,
help="treat sizes as outside measurements that include the walls") help="treat sizes as outside measurements that include the walls [\U0001F6C8](https://florianfesti.github.io/boxes/html/usermanual.html#outside)")
elif arg == "nema_mount": elif arg == "nema_mount":
if default is None: default = 23 if default is None: default = 23
self.argparser.add_argument( self.argparser.add_argument(