package crs

  1. Overview
  2. Docs
A tool for managing code review comments embedded in source code

Install

dune-project
 Dependency

Authors

Maintainers

Sources

crs-0.0.20250914.tbz
sha256=dad0c46a83ef40da150d8b840b01c66af3b979dfa7c3e17c3edef38aa84b804f
sha512=d7a8b2a34f4a3ddda0eaaa3e4248ec2870f944a5d64782bd73b031637b01e94a378d7534b1c02da739f32343b342ed8e8bf491e6442a3bd7b0e748bd61c58770

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

Module Private.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:Base.string -> Maybe_invalid_cr.t
On This Page
  1. Parse