package crs
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=c9639ddde0d9126acf847a7b27a84db161b2bfbb7d3c69bba88a4fcfe1d3db21
sha512=34cfa8d001b5f8a87bdf3b78c15150f338c99cb575e8c85e6c398381f953727e0a0267c564d757330e28a57a5eedc27cb72681f82833197b17fa8d1c28a2df05
doc/crs.cr-comment/Cr_comment/index.html
Module Cr_commentSource
A Cr_comment.t is an immutable value holding the information and metadata about a CR that was parsed from a file.
Getters
content is the text of the CR with comment markers removed from the beginning and end (if applicable). See also reindented_content.
whole_loc is suitable for removal of the entire CR comment. It includes the comments boundaries from path as well.
due t is a convenience wrapper to get the due property of the CR header. This returns Now when parsing the header resulted in an error.
work_on t represents the expectation as to when work on the CR is meant to happen. Is it similar to due t except that XCRs are meant to be worked on Now.
This digest is computed such that changes in positions in a file, or changes in whitespaces are ignored. It is used by downstream systems to detect that two CRs are equivalent, which in turn may affect when a CR is active.
Show the CR with a line showing the file position.
reindented_content t returns the content of the CR with leading indentation removed or normalized. This is useful for displaying multiple CRs together in a unified format, such as in crs grep.
Sorts the supplied list of CRs and outputs it to the supplied out channel, separated by newline characters.
A convenient wrapper for output_list that prints to stdout.
Sort
Private
This module is exported to be used by libraries with strong ties to cr_comment. Its signature may change in breaking ways at any time without prior notice, and outside the guidelines set by semver.
In particular, the intention here is that CRs may only be created using dedicated helpers libraries that are defined in this project, parsing them from files in vcs trees.