package crs

  1. Overview
  2. Docs
On This Page
  1. Parse
package crs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

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