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

docs: "Library Initialization" doesn't use a consistent convention for imported Automerge #101

Open
joshuahhh opened this issue Nov 21, 2024 · 0 comments

Comments

@joshuahhh
Copy link

The page https://automerge.org/docs/library_initialization/ uses four different conventions for accessing "next" in Automerge:

  • A
    • import { next as A } from "@automerge/automerge"
  • Am
    • import { next as Am } from "npm:@automerge/automerge"
  • automerge.next
    • import * as automerge from "npm:@automerge/automerge/slim";
  • Automerge
    • import { next as Automerge } from "@automerge/automerge/slim";

To be clear, I'm not referring here to the different sources of imports, just to the name by which the "next" object is accessed in user code.

I don't see a reason for these to be different from each other. If that's right, it would be easier to understand the code and compare the approaches if they were the same.

Is there a preferred name? If so, I'd be happy to make the change.

Thanks!

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

No branches or pull requests

1 participant