package crs

  1. Overview
  2. Docs
On This Page
  1. Parse
A tool for managing inline review comments embedded in source code

Install

dune-project
 Dependency

Authors

Maintainers

Sources

crs-0.0.20260307.tbz
sha256=77f77c61e908a6716fa876f5648f662ffaf7e24be4a7889fd6b53121592311bb
sha512=5fc6252650571c4127ebb1e61fecf78c5d4ce35e2832dff47125cda1448e07ea6d4da5e3a9a28643e3491d3594b0ee8857214241f98bd0296ada2c35ea8daa4b

doc/crs.crs-parser/Crs_parser/Private/Std/Invalid_cr_parser/index.html

Module Std.Invalid_cr_parserSource

A module to help managing invalid CRs.

Sometimes during parsing we find comments fragments that kind of look like CRs, but are not quite valid ones. In this case, we need to decide what to do. On one hand we'd like to draw the attention of reviewers on fragments that we think are probably CRs, so they can fix them, and address them. On the other hand, we'd like to avoid noisy false positive, and thus we must ignore fragments that are too unlikely to be actual CRs.

This is not a perfect process, and we make use of some heuristics and opinionated choices in this implementation. The behavior is characterized precisely in the test suite, for reference.

Sourcemodule Invalid_cr : sig ... end

Parse

Sourcemodule Maybe_invalid_cr : sig ... end
Sourceval parse : file_cache:Loc.File_cache.t -> content_start_offset:Loc.Offset.t -> content:string -> Maybe_invalid_cr.t