summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorA Farzat <a@farzat.xyz>2026-06-21 11:44:26 +0300
committerA Farzat <a@farzat.xyz>2026-06-21 11:44:26 +0300
commit84b497fe446511ce832afcea30683b8e070bed10 (patch)
tree68843c35b085218b8080af3f7afce001ecb3b84c
parentb012c1e6037ba3f89b9cdbd599f9d2650c1ad691 (diff)
downloadrepo2markdown-84b497fe446511ce832afcea30683b8e070bed10.tar.gz
repo2markdown-84b497fe446511ce832afcea30683b8e070bed10.zip
Add module docs to binaries
-rw-r--r--src/bin/r2md-append.rs5
-rw-r--r--src/bin/r2md-fence.rs6
-rw-r--r--src/bin/r2md-prepend.rs5
-rw-r--r--src/bin/r2md-remove.rs5
-rw-r--r--src/main.rs5
5 files changed, 26 insertions, 0 deletions
diff --git a/src/bin/r2md-append.rs b/src/bin/r2md-append.rs
index 4dd0698..0c84164 100644
--- a/src/bin/r2md-append.rs
+++ b/src/bin/r2md-append.rs
@@ -1,3 +1,8 @@
+//! Entry point for the `r2md-append` helper binary.
+//!
+//! This binary reads a NUL-separated path list from stdin, appends additional paths supplied as
+//! command-line arguments, and writes the updated path list to stdout.
+
use std::{ffi::OsString, io};
use clap::Parser;
diff --git a/src/bin/r2md-fence.rs b/src/bin/r2md-fence.rs
index cced391..b25b5c6 100644
--- a/src/bin/r2md-fence.rs
+++ b/src/bin/r2md-fence.rs
@@ -1,3 +1,9 @@
+//! Entry point for the `r2md-fence` helper binary.
+//!
+//! This binary reads stdin, wraps it in a Markdown fenced code block, and writes the result to
+//! stdout. It is useful for safely embedding generated Markdown or arbitrary text inside LLM
+//! prompts or another Markdown document.
+
use std::io;
use clap::Parser;
diff --git a/src/bin/r2md-prepend.rs b/src/bin/r2md-prepend.rs
index 7297fb6..6c8ed32 100644
--- a/src/bin/r2md-prepend.rs
+++ b/src/bin/r2md-prepend.rs
@@ -1,3 +1,8 @@
+//! Entry point for the `r2md-prepend` helper binary.
+//!
+//! This binary reads a NUL-separated path list from stdin, prepends additional paths supplied as
+//! command-line arguments, and writes the updated path list to stdout.
+
use std::{ffi::OsString, io};
use clap::Parser;
diff --git a/src/bin/r2md-remove.rs b/src/bin/r2md-remove.rs
index 07c9124..20d69c1 100644
--- a/src/bin/r2md-remove.rs
+++ b/src/bin/r2md-remove.rs
@@ -1,3 +1,8 @@
+//! Entry point for the `r2md-remove` helper binary.
+//!
+//! This binary reads a NUL-separated path list from stdin, removes paths supplied as command-line
+//! arguments after normalization, and writes the filtered path list to stdout.
+
use std::{io, path::PathBuf};
use clap::Parser;
diff --git a/src/main.rs b/src/main.rs
index 3a89188..8cbbadb 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,3 +1,8 @@
+//! Entry point for the main `repo2markdown` binary.
+//!
+//! This binary parses command-line arguments, connects stdin/stdout, and delegates the actual
+//! rendering pipeline to [`run::run`].
+
mod cli;
mod run;