From ac82f09a6910d17ca090b88d9f7f1ad1316f7ace Mon Sep 17 00:00:00 2001 From: Christine Rose Date: Wed, 28 Aug 2024 00:55:00 -0700 Subject: [PATCH 1/2] minor line editing --- doc/irmin-pack/index.mld | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/irmin-pack/index.mld b/doc/irmin-pack/index.mld index 3bef537950..0bb244d622 100644 --- a/doc/irmin-pack/index.mld +++ b/doc/irmin-pack/index.mld @@ -1,8 +1,8 @@ {0 irmin-pack} -The [irmin-pack] package provides a space-optimized, on-disk backend inspired by {{:https://git-scm.com/book/en/v2/Git-Internals-Packfiles} Git Packfiles}. +The [irmin-pack] package provides a space-optimised, on-disk backend inspired by {{:https://git-scm.com/book/en/v2/Git-Internals-Packfiles} Git Packfiles}. -[irmin-pack] is designed and developed for a specific use-case and requires more in-depth backend configuration from applications. It offers additional functionality through extensions to the core Irmin API, but users interested in a more general Irmin backend with simpler configuration are recommended to use other backend such as {!Irmin_fs} or {!Irmin_git}. +[irmin-pack] is designed and developed for a specific use-case and requires more in-depth backend configuration from applications. It offers additional functionality through extensions to the core Irmin API, but users interested in a more general Irmin backend with simpler configuration are recommended to use other backends, such as {!Irmin_fs} or {!Irmin_git}. See [examples/irmin-pack] for examples of how to configure and use some of the additional functionality. @@ -12,8 +12,8 @@ The entry point of this library is the module {!module:Irmin_pack}. {2 [irmin-pack.mem]} -The entry point of this library is the module {!module:Irmin_pack_mem}. +The module {!module:Irmin_pack_mem} is this library's entry point. {2 [irmin-pack.unix]} -The entry point of this library is the module {!module:Irmin_pack_unix}. \ No newline at end of file +The module {!module:Irmin_pack_unix} is this library's entry point. From 40ae4761b010d7aadc70655b513d371c034f7fa0 Mon Sep 17 00:00:00 2001 From: Christine Rose Date: Wed, 28 Aug 2024 00:55:24 -0700 Subject: [PATCH 2/2] missed formatting --- doc/irmin-pack/index.mld | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/irmin-pack/index.mld b/doc/irmin-pack/index.mld index 0bb244d622..3e9875c8cb 100644 --- a/doc/irmin-pack/index.mld +++ b/doc/irmin-pack/index.mld @@ -1,4 +1,4 @@ -{0 irmin-pack} +{0 [irmin-pack]} The [irmin-pack] package provides a space-optimised, on-disk backend inspired by {{:https://git-scm.com/book/en/v2/Git-Internals-Packfiles} Git Packfiles}.