Skip to content

Commit

Permalink
Comment on Shell_dsl module
Browse files Browse the repository at this point in the history
  • Loading branch information
gridbugs committed May 31, 2024
1 parent 02b8942 commit c9ce789
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/shell_dsl.mli
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
open! Import

(** A DSL for writing shell scripts intended for use in completion
scripts. This provides some benefits over generating shell scripts
directly with strings:
- Formatting such as indentation and comment wrapping can be
applied automatically and in a centralized place.
- One could conceivably emit a completion script in other
languages besides bash one day, though this will likely require
some tweaking to make work. *)

(** Equal to [Stmt.t]. Exposed to break a dependency cycle with
[Global_named_value.function_]. *)
type stmt
Expand Down

0 comments on commit c9ce789

Please sign in to comment.