Drivers can now include a dedicated description file, making instructions and usage guidance more accessible to users directly within the software.
To provide documentation for a driver, include one of the following files in the driver directory:
-
doc/description.md(Markdown) -
doc/description.html(HTML)
If a description file is present, SweepMe! displays a help icon next to the driver in the driver dropdown. Clicking this icon opens the documentation directly in the software, providing a more user-friendly experience than previous docstrings or inline comments. You can even reference images which you also put into the doc directory.
Even if a driver is not publicly available, adding a description is recommended to help future developers understand and maintain it. Full instructions are available in our wiki.
As an example, the Switch-Rohde&Schwarz_NGPV driver uses this new feature:
This driver was contributed by Christian, and it now includes a description accessible via the new help system. Version 2025-08-25 can be downloaded from the SweepMe! Version Manager or developers can view it in the GitHub repository.
We encourage all driver developers to take advantage of this feature to make their drivers easier to use and maintain.