Pipeline Details
Click on a pipeline to view details about the documentation run, including statistics on the amount of code processed. These details update dynamically in real time as the pipeline progresses.
(1) User who triggered the pipeline. Clicking on the user opens a new tab with the user’s profile on the originating Git platform.
(2) Link to configuration settings for the repository where this pipeline ran.
(3) Languages documented in this pipeline. For repositories with multiple languages, we display the five most documented ones.
(4) Precise timestamps when the pipeline began and completed the documentation job.
Pipeline Stats
Detailed statistics for the pipeline are available if Komment documented at least one item during the run.
(1) Total files processed in the pipeline, including the fraction of files skipped and documented
Komment scans files and automatically identifies code items that should be documented. All files ingested and parsed by Komment are categorized as Processed, whether or not they were documented. A file is considered Documented if Komment generated docs for at least one item within it. Files that Komment's algorithm decides not to document are marked as Skipped.
(2) Total items processed in the pipeline, including the fraction of items skipped and documented
An item is a code construct or arbitrary pocket of complexity that Komment identifies appropriate for documentation. This could be a class, method, a particularly complex sub-query, modules, or even an entire library.
(3) Total lines of code processed in the pipeline, including the fraction of lines skipped and documented