package crs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

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

M

Mathieu Barbin

Maintainers

M

Mathieu Barbin <opensource@mbarbin.org>

Sources

crs-0.0.20250914.tbz

sha256=dad0c46a83ef40da150d8b840b01c66af3b979dfa7c3e17c3edef38aa84b804f

sha512=d7a8b2a34f4a3ddda0eaaa3e4248ec2870f944a5d64782bd73b031637b01e94a378d7534b1c02da739f32343b342ed8e8bf491e6442a3bd7b0e748bd61c58770

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

Module `Header.With_loc`Source

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.

Sourceval reporter : t -> Volgo.Vcs.User_handle.t Loc.Txt.t

The location includes the entire reporter username, without the surrounding spaces.

Sourceval recipient : t -> Volgo.Vcs.User_handle.t Loc.Txt.t Base.option

The location includes the entire recipient username, if it is present, without the surrounding spaces. In particular, the location does not include the "for" keyword itself.

Sourceval status : t -> Status.t Loc.Txt.t

The location includes the entire keyword "CR" or "XCR" depending on the case. It stops right before the following char, that being a space or a '-' (and thus does not include it).

Sourceval qualifier : t -> Qualifier.t Loc.Txt.t

When the CR is qualified as Soon or Someday, the location returned starts right after the dash separator (but does not include it), and contains the entire qualifier keyword. For example, the location will include "soon" for a CR-soon. When the CR has no qualifier, there is no keyword to attach a location to : conventionally, we return instead the location of the CR status in this case.

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 kind : t -> Status.t Loc.Txt.t

This was renamed status. Hint: Run ocamlmig migrate.

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

This was renamed reporter. Hint: Run ocamlmig migrate.

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

This was renamed recipient. Hint: Run ocamlmig migrate.

Sourceval due : t -> Qualifier.t Loc.Txt.t

This was renamed qualifier. Hint: Run ocamlmig migrate.