package crs

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

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (3)

Authors

  1. M
    Mathieu Barbin

Maintainers

  1. M
    Mathieu Barbin <opensource@mbarbin.org>

Sources

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

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

Module Cr_comment.HeaderSource

Sourcetype t
include Ppx_compare_lib.Equal.S with type t := t
Sourceval equal : t -> t -> bool
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

reporter is user in CR user....

recipient is user2 in CR user1 for user2: .... Assigning CRs to particular users is optional. This returns None if that part is left out, such as in CR user1: Comment.

Sourceval status : t -> Status.t
Sourceval qualifier : t -> Qualifier.t

This returns the qualifier if present (Soon for CR-soon or Someday for CR-someday). If there is no qualifier specified, this returns None.

Sourceval priority : t -> Priority.t

priority t represents the expectation as to when work on the CR is meant to happen. It is based on the header's qualifier.

Sourcemodule With_loc : sig ... end

These getters allows you to access the position of each elements of the CR header. This is meant for tools processing CRs automatically, such as CRs rewriters.

Deprecated

The following is deprecated and will be soon annotated as such with ocaml alerts. Please migrate, and do not use in new code.

Sourceval reported_by : t -> Volgo.Vcs.User_handle.t

This was renamed reporter. Hint: Run ocamlmig migrate.

Sourceval for_ : t -> Volgo.Vcs.User_handle.t Base.option

This was renamed recipient. Hint: Run ocamlmig migrate.

Sourceval kind : t -> Status.t

This was renamed status. Hint: Run ocamlmig migrate.