Operator options are missing from the User Guide

[tbirdso]

Overview

During investigation of https://github.com/nvidia-holoscan/holoscan-sdk/issues/22 we determined that some Holoscan C++ operators are not fully documented in the Holoscan SDK User Guide.

Details

In investigating #22 we determined that the VideoStreamRecorderOp user documentation does not fully describe operator options. Specifically, the flush_on_tick option is not noted in the user guide.

We will investigate our documentation process and update so that all operator parameters are readily apparent in the user guide.

Workaround

You can view a full list of operator options with the Python help command:

>>> help(VideoStreamRecorderOp)
__init__(...)
 |      __init__(self: holoscan.operators.video_stream_recorder._video_stream_recorder.VideoStreamRecorderOp, fragment: holoscan.core._core.Fragment, directory: str, basename: str, flush_on_tick: bool = False, name: str = 'recorder') -> None
 |      
 |      Operator class to record the video stream to a file.
 |      
 |      Named inputs:
 |          input: nvidia::gxf::Tensor
 |              A message containing a video frame to serialize to disk.
 |      
 |      Parameters
 |      ----------
 |      fragment : holoscan.core.Fragment
 |          The fragment that the operator belongs to.
 |      directory : str
 |          Directory path for storing files.
 |      basename : str
 |          User specified file name without extension.
 |      flush_on_tick : bool, optional
 |          Flushes output buffer on every tick when ``True``.
 |      name : str, optional
 |          The name of the operator

Alternatively, operator parameters are available for review in holoscan-sdk source code headers in this repository.

Versions

1.0.3