package crs

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

Install

Dune Dependency

Authors

Maintainers

Sources

crs-0.0.20250705.tbz
sha256=e9f9f5ec5aea9658ed640aaa06f887985bb6870adcf7555ebf6d48bb741e4793
sha512=901ac1caae6c4103a320b4a3a177ca3aa0583ad533c54e7740aba6652ccdbd6311d07ab4b73e3ba750beed24f85479b5e1b0e94504ecfd0c59bd49cdabebc369

doc/crs.cr-comment/Cr_comment/Qualifier/index.html

Module Cr_comment.QualifierSource

Sourcetype t =
  1. | None
  2. | Soon
  3. | Someday

The Qualifier.t type represents an optional keyword that can be attached to a code review comment (CR) using the CR syntax. This classification is a general convenience provided by the library to help organize and filter CRs, but the exact workflow and expectations associated with each qualifier — such as when a Soon or Someday comment should be addressed — are intentionally left undefined here.

It is up to higher-level tools or code review systems built on top of CRs to define and enforce specific policies or behaviors around these qualifiers.

As a rule of thumb:

  • None: Should be addressed promptly.
  • Soon: Should be addressed in the near future.
  • Someday: Can be deferred until later.

These categories are intended to be flexible and adaptable to the needs of various development process.

include Ppx_compare_lib.Comparable.S with type t := t
Sourceval compare : t -> t -> int
include Ppx_compare_lib.Equal.S with type t := t
Sourceval equal : t -> t -> bool
include Ppx_enumerate_lib.Enumerable.S with type t := t
Sourceval all : t list
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval priority : t -> Priority.t

This returns the priority according to the qualifier, if we were to take nothing else into account.

OCaml

Innovation. Community. Security.