docs: add docstrings

This commit is contained in:
Remi Gelinas
2024-07-18 11:03:23 -04:00
parent 0197f6d15e
commit 699fce0ee5
2 changed files with 7 additions and 1 deletions

View File

@ -20,7 +20,12 @@ pub const Options = struct {
}
};
/// The `validate-config` command is used to validate a Ghostty config
/// The `validate-config` command is used to validate a Ghostty config file.
///
/// When executed without any arguments, this will load the config from the default location.
///
/// The `--config-file` argument can be passed to validate a specific target config
/// file in a non-default location.
pub fn run(alloc: std.mem.Allocator) !u8 {
var opts: Options = .{};
defer opts.deinit();

View File

@ -1686,6 +1686,7 @@ pub fn loadIter(
try cli.args.parse(Config, alloc, self, iter);
}
/// Load configuration from the target config file at `path`.
pub fn loadFile(self: *Config, alloc: Allocator, path: []const u8) !void {
var file = try std.fs.cwd().openFile(path, .{});
defer file.close();