Merge pull request #123 from mbarbin/inline-comments

Inline comments

Author: mbarbin

.crs-ignore

@@ -3,6 +3,6 @@
 # would not be grepped as actual CRs. However doing this adds a level of
 # complexity for new readers and people discovering the project. Ignoring CRs
 # from the README prevents us from using the CRs workflow in this file. We've
-# accepted this tradeof.
+# accepted this tradeoff.
 
 README.md

.vscode/settings.json

@@ -9,68 +9,95 @@
         "autofmt",
         "Barbin",
         "cadr",
+        "Caml",
         "chdir",
         "cmdlang",
         "cmdliner",
         "cnum",
         "codemods",
         "compl",
         "conv",
+        "decr",
         "defconst",
         "defcustom",
         "defgroup",
         "defun",
         "defvar",
+        "depexts",
         "descr",
+        "destdir",
         "Diátaxis",
         "docstrings",
         "docv",
+        "dunolint",
         "EINTR",
         "eldev",
+        "elif",
         "elisp",
         "endline",
         "execp",
         "failwith",
+        "fboundp",
         "fname",
         "Fpath",
+        "fprintf",
         "Fsegment",
         "getcwd",
+        "gpatch",
+        "groupi",
+        "hideable",
         "hlist",
         "hpad",
+        "iteri",
         "janestreet",
         "jdoe",
         "keymap",
+        "lfindi",
         "lnum",
+        "lsplit",
         "lstrip",
+        "mapi",
         "Mathieu",
         "mbarbin",
         "MELPA",
+        "nativeint",
         "nonrec",
+        "nontail",
+        "numpy",
+        "ocamlformat",
         "ocamlmig",
         "odoc",
         "opam",
+        "OPAMYES",
         "pageantty",
         "patdiff",
         "pplumbing",
         "ppxlib",
+        "prerr",
         "printbox",
         "Printexc",
         "progn",
+        "protoc",
         "rdjson",
         "reindentation",
         "reindented",
         "relpath",
         "repn",
         "reviewdog",
+        "rfindi",
         "rstrip",
+        "rstripped",
+        "runtest",
         "setq",
         "sexp",
         "sexplib",
         "sherlodoc",
         "shexp",
         "sigpipe",
+        "softprops",
         "sprintf",
         "stdlib",
+        "stdune",
         "Streeters",
         "stringable",
         "stringp",

CHANGES.md

@@ -1,4 +1,4 @@
-## 0.0.202XXXXX (unreleased)
+## 0.0.20260202 (2026-02-02)
 
 Starting from this version we're using GitHub immutable releases.
 
@@ -10,6 +10,8 @@ Starting from this version we're using GitHub immutable releases.
 
 ### Changed
 
+- Improve project synopsis and update source headers (#123, @mbarbin).
+- Migrate main and doc CIs to `setup-dune` (#122, @mbarbin).
 - Increase some lower bounds to ease maintenance (#119, @mbarbin).
 - Adapt release artifacts jobs for immutable releases (@mbarbin).
 - Make type `User_handle` independent instead of from `Vcs` (#116, @mbarbin).
@@ -117,7 +119,7 @@ Starting from this version we're using GitHub immutable releases.
 
 ### Fixed
 
-- Fix rendering of empty lines in multilines CRs with comment prefix (@mbarbin).
+- Fix rendering of empty lines in multiline CRs with comment prefix (@mbarbin).
 
 ## 0.0.20250626 (2025-06-26)
 

COPYING.HEADER

@@ -1,5 +1,5 @@
-crs - A tool for managing code review comments embedded in source code
-Copyright (C) 2024-2025 Mathieu Barbin <mathieu.barbin@gmail.com>
+crs - A tool for managing inline review comments embedded in source code
+Copyright (C) 2024-2026 Mathieu Barbin <mathieu.barbin@gmail.com>
 
 This file is part of crs.
 

NOTICE.md

@@ -26,7 +26,7 @@ We've included a copy of Iron's `Apache-2.0` License in the repository [here](./
 
 We're referring to the Iron source code as of `v0.9.114.44+47`, revision `dfb106cb82abf5d16e548d4ee4f419d0994d3644`.
 
-`Iron` includes functionality for interacting with `Mercurial` repositories, and parsing code review comments embedded in source code.
+`Iron` includes functionality for interacting with `Mercurial` repositories, and parsing review comments embedded in source code.
 
 To build this project, we've used a format for code review comments almost identical to the syntax used by Iron. Moreover, we have used as a starting point the code from Iron responsible for modeling and parsing the comments.
 

README.md

@@ -7,7 +7,7 @@
 
 ## Introduction
 
-Welcome to **crs**, a project that provides libraries and a command-line interface to help manage code review comments embedded directly in source code using a specialized syntax.
+Welcome to **crs**, a project that provides libraries and a command-line interface to help manage inline review comments embedded directly in source code using a specialized syntax.
 
 ### A Quick Example of a Code Review Comment (CR)
 

crs.opam

@@ -1,6 +1,7 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-synopsis: "A tool for managing code review comments embedded in source code"
+synopsis:
+  "A tool for managing inline review comments embedded in source code"
 maintainer: ["Mathieu Barbin <opensource@mbarbin.org>"]
 authors: ["Mathieu Barbin"]
 license: "LGPL-3.0-or-later WITH LGPL-3.0-linking-exception"
@@ -50,7 +51,7 @@ build: [
 dev-repo: "git+https://github.com/mbarbin/crs.git"
 description: """\
 
-The [crs] package provides libraries and a CLI to help manage code
+The [crs] package provides libraries and a CLI to help manage inline
 review comments embedded directly in source code using a specialized
 syntax.
 
@@ -77,5 +78,5 @@ ideas.
 [iron]: https://github.com/janestreet/iron
 
 """
-tags: [ "code-review" ]
+tags: [ "code-review" "inline-comments" ]
 x-maintenance-intent: [ "(latest)" ]

crs.opam.template

@@ -1,6 +1,6 @@
 description: """\
 
-The [crs] package provides libraries and a CLI to help manage code
+The [crs] package provides libraries and a CLI to help manage inline
 review comments embedded directly in source code using a specialized
 syntax.
 
@@ -27,5 +27,5 @@ ideas.
 [iron]: https://github.com/janestreet/iron
 
 """
-tags: [ "code-review" ]
+tags: [ "code-review" "inline-comments" ]
 x-maintenance-intent: [ "(latest)" ]

doc/blog/2025-07-31-launching-crs-workflows/index.md

@@ -6,15 +6,15 @@ tags: [ci, github]
 ---
 
 **TL;DR:**
-🚀 I’m launching CRs Workflows — GitHub Actions for code review comments embedded directly in your source code. They’re new, open source, and looking for adventurous early adopters and collaborators! See real examples and visuals in the linked workflows below.
+🚀 I’m launching CRs Workflows — GitHub Actions for inline review comments embedded directly in your source code. They’re new, open source, and looking for adventurous early adopters and collaborators! See real examples and visuals in the linked workflows below.
 
 <!-- truncate -->
 
 They're brand new, simple yet intriguing — and most importantly, they're now available on GitHub: [CRs Workflows](https://github.com/mbarbin/crs-actions) are looking for early adopters.
 
 ## Huh? What's a CR?
 
-CRs are code review comments embedded directly in source code! [Learn more here](https://mbarbin.github.io/crs/).
+CRs are inline review comments embedded directly in source code! [Learn more here](https://mbarbin.github.io/crs/).
 
 ## What's a CR Workflow?
 

doc/docusaurus.config.ts

@@ -4,7 +4,7 @@ import type * as Preset from '@docusaurus/preset-classic';
 
 const config: Config = {
   title: 'CRs',
-  tagline: 'A tool for managing code review comments embedded in source code',
+  tagline: 'A tool for managing inline review comments embedded in source code',
   // favicon: 'img/favicon.ico',
 
   // Set the production url of your site here