warehack.ing/WireViz
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove references for unsupported output formats

Browse Source 
Remove the references in the CLI help, but keep the placeholders elsewhere in the code as a TODO
This commit is contained in:
Daniel Rojas 2025-03-01 17:35:19 +01:00
parent 0fed30aa05
commit 701815874c
2 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/wireviz/wireviz.py
View File

@ -44,10 +44,8 @@ def parse(
* "harness": the diagram as a Harness Python object * "harness": the diagram as a Harness Python object
Supported output formats: Supported output formats:
* "csv": the BOM, as a comma-separated text file
* "gv": the diagram, as a GraphViz source file * "gv": the diagram, as a GraphViz source file
* "html": the diagram and (depending on the template) the BOM, as a HTML file * "html": the diagram and (depending on the template) the BOM, as a HTML file
* "png": the diagram, as a PNG raster image
* "pdf": the diagram and (depending on the template) the BOM, as a PDF file * "pdf": the diagram and (depending on the template) the BOM, as a PDF file
* "svg": the diagram, as a SVG vector image * "svg": the diagram, as a SVG vector image
* "tsv": the BOM, as a tab-separated text file * "tsv": the BOM, as a tab-separated text file
@ -81,6 +79,7 @@ def parse(
* SVG data * SVG data
* a Harness object * a Harness object
""" """
# TODO: add CSV and PDF to docstring once they are supported
if not output_formats and not return_types: if not output_formats and not return_types:
raise Exception("No output formats or return types specified") raise Exception("No output formats or return types specified")

4
src/wireviz/wv_cli.py
View File

@ -14,11 +14,11 @@ from wireviz import APP_NAME, __version__
from wireviz.wv_utils import open_file_read from wireviz.wv_utils import open_file_read
format_codes = { format_codes = {
"c": "csv", # "c": "csv", # TODO: support CSV
"g": "gv", "g": "gv",
"h": "html", "h": "html",
"p": "png", "p": "png",
"P": "pdf", # "P": "pdf", # TODO: support PDF
"s": "svg", "s": "svg",
"t": "tsv", "t": "tsv",
} }