From d1cc2b2a7dd0928ebd94a3f18336b5515e95c60c Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Fri, 13 Jan 2023 18:07:34 +0100
Subject: [PATCH] Touch up the option docs to be proper markdown

---
 src/nix/modules/composition/host-environment.nix |  6 +++---
 src/nix/modules/composition/images.nix           |  2 +-
 src/nix/modules/service/extended-info.nix        |  2 +-
 src/nix/modules/service/host-store.nix           |  2 +-
 src/nix/modules/service/image.nix                | 12 ++++++------
 5 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/src/nix/modules/composition/host-environment.nix b/src/nix/modules/composition/host-environment.nix
index 5989695..0ff373d 100644
--- a/src/nix/modules/composition/host-environment.nix
+++ b/src/nix/modules/composition/host-environment.nix
@@ -23,9 +23,9 @@
         stored at an alternate location without altering the format of
         store paths.
 
-        For example: instead of mounting the host's /nix/store as the
-        container's /nix/store, this will mount /mnt/foo/nix/store
-        as the container's /nix/store.
+        For example: instead of mounting the host's `/nix/store` as the
+        container's `/nix/store`, this will mount `/mnt/foo/nix/store`
+        as the container's `/nix/store`.
       '';
     };
 
diff --git a/src/nix/modules/composition/images.nix b/src/nix/modules/composition/images.nix
index 0377100..c3c09a3 100644
--- a/src/nix/modules/composition/images.nix
+++ b/src/nix/modules/composition/images.nix
@@ -36,7 +36,7 @@ in
     build.imagesToLoad = lib.mkOption {
       type = listOf unspecified;
       internal = true;
-      description = "List of dockerTools image derivations.";
+      description = "List of `dockerTools` image derivations.";
     };
   };
   config = {
diff --git a/src/nix/modules/service/extended-info.nix b/src/nix/modules/service/extended-info.nix
index 7d14a59..1341888 100644
--- a/src/nix/modules/service/extended-info.nix
+++ b/src/nix/modules/service/extended-info.nix
@@ -12,7 +12,7 @@ in
       type = attrsOf unspecified;
       description = ''
         Information about a service to include in the Docker Compose file,
-        but that will not be used by the `docker-compose`> command
+        but that will not be used by the `docker-compose` command
         itself.
 
         It will be inserted in `x-arion.serviceInfo.<service.name>`.
diff --git a/src/nix/modules/service/host-store.nix b/src/nix/modules/service/host-store.nix
index f50c509..621013a 100644
--- a/src/nix/modules/service/host-store.nix
+++ b/src/nix/modules/service/host-store.nix
@@ -20,7 +20,7 @@ in
     service.hostStoreAsReadOnly = mkOption {
       type = types.bool;
       default = true;
-      description = "Adds a ':ro' (read-only) access mode to the host nix store bind mount.";
+      description = "Adds a `:ro` (read-only) access mode to the host nix store bind mount.";
     };
     service.useHostNixDaemon = mkOption {
       type = types.bool;
diff --git a/src/nix/modules/service/image.nix b/src/nix/modules/service/image.nix
index 8700396..7697e36 100644
--- a/src/nix/modules/service/image.nix
+++ b/src/nix/modules/service/image.nix
@@ -76,18 +76,18 @@ in
     build.image = mkOption {
       type = nullOr package;
       description = ''
-        Docker image derivation to be `docker load`ed.
+        Docker image derivation to be `docker load`-ed.
       '';
       internal = true;
     };
     build.imageName = mkOption {
       type = str;
-      description = "Derived from build.image";
+      description = "Derived from `build.image`";
       internal = true;
     };
     build.imageTag = mkOption {
       type = str;
-      description = "Derived from build.image";
+      description = "Derived from `build.image`";
       internal = true;
     };
     image.nixBuild = mkOption {
@@ -126,7 +126,7 @@ in
       internal = true;
       description = ''
         Include all referenced store paths. You generally want this in your
-        image, unless you load store paths via some other means, like useHostStore = true;
+        image, unless you load store paths via some other means, like `useHostStore = true`;
       '';
     };
     image.rawConfig = mkOption {
@@ -140,8 +140,8 @@ in
         Please use the specific `image` options instead.
 
         Run-time configuration of the container. A full list of the
-        options is available in the https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions[Docker Image Specification
-        v1.2.0].
+        options is available in the [Docker Image Specification
+        v1.2.0](https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions).
       '';
     };
     image.command = mkOption {