Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc Review for 03_getting-started.md #152

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

christinerose
Copy link
Collaborator

Line editing and code testing. I've put linked items in monospace if they'd normally be that way. If the links won't work with monospace formatting, I'll go change them back.

Also I wasn't able to test all the code yet. I get a zsh: number expected error when I run this and the following example:

module Mem_store = Irmin_mem.KV.Make(Irmin.Contents.String)

Also, code examples that look like this (below) aren't clear. They appear to modify a file, but it's not clear which file. It doesn't appear to go into the CLI. Please clarify for me. 🙂

module Mem_schema = struct
  module Info = Irmin.Info.Default
  module Metadata = Irmin.Metadata.None
  module Contents = Irmin.Contents.Json
  module Path = Irmin.Path.String_list
  module Branch = Irmin.Branch.String
  module Hash = Irmin.Hash.SHA1
  module Node = Irmin.Node.Make(Hash)(Path)(Metadata)
  module Commit = Irmin.Commit.Make(Hash)
end

module Mem_Store =
    Irmin_mem.Make
        (Mem_schema)

I'll also put these as comments at the line in the doc.


An in-memory store with string contents:
To create an in-memory store with string contents, run:

```ocaml
module Mem_store = Irmin_mem.KV.Make(Irmin.Contents.String)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get a zsh: number expected error when I run this and the one on li. 47.

@@ -73,13 +73,13 @@ module Mem_Store =
(Mem_schema)
```

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not clear where to apply this example and others formatted like it. It doesn't seem like it's to be tested in the CLI, so I suspect it's to amend a file....but which file?

Same question for others throughout.

@christinerose christinerose self-assigned this Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant