From 701815874ce2a413d7f11e7f3bac22cd7ac9ce61 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Sat, 1 Mar 2025 17:35:19 +0100 Subject: [PATCH] Remove references for unsupported output formats Remove the references in the CLI help, but keep the placeholders elsewhere in the code as a TODO --- src/wireviz/wireviz.py | 3 +-- src/wireviz/wv_cli.py | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/src/wireviz/wireviz.py b/src/wireviz/wireviz.py index e147708..08fbe12 100755 --- a/src/wireviz/wireviz.py +++ b/src/wireviz/wireviz.py @@ -44,10 +44,8 @@ def parse( * "harness": the diagram as a Harness Python object Supported output formats: - * "csv": the BOM, as a comma-separated text file * "gv": the diagram, as a GraphViz source 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 * "svg": the diagram, as a SVG vector image * "tsv": the BOM, as a tab-separated text file @@ -81,6 +79,7 @@ def parse( * SVG data * a Harness object """ + # TODO: add CSV and PDF to docstring once they are supported if not output_formats and not return_types: raise Exception("No output formats or return types specified") diff --git a/src/wireviz/wv_cli.py b/src/wireviz/wv_cli.py index 4c6ac8f..eafc0ef 100644 --- a/src/wireviz/wv_cli.py +++ b/src/wireviz/wv_cli.py @@ -14,11 +14,11 @@ from wireviz import APP_NAME, __version__ from wireviz.wv_utils import open_file_read format_codes = { - "c": "csv", + # "c": "csv", # TODO: support CSV "g": "gv", "h": "html", "p": "png", - "P": "pdf", + # "P": "pdf", # TODO: support PDF "s": "svg", "t": "tsv", }