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

Improved Documentation Request #908

Open
jbryanh opened this issue Feb 17, 2022 · 1 comment
Open

Improved Documentation Request #908

jbryanh opened this issue Feb 17, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@jbryanh
Copy link

jbryanh commented Feb 17, 2022

Is your feature request related to a problem? Please describe.
When a user starts out implementing Hive, the documentation is incomplete, particularly if the user wants to use the hive_generator. Too much prior knowledge is assumed of users.

Describe the solution you'd like
I'd just propose that here: https://docs.hivedb.dev/#/custom-objects/generate_adapter
Step One should reiterate the dependencies as listed here: https://docs.hivedb.dev/#/README
1-2 become 2-3
#4 needs to detail including part "...." in the model file user is employing;
#5 Then is the build_runner command - optimally with some explanation of what's happening here.
#6 Register the adapter.

That's all, thanks for the great plugin.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Version

  • Platform: iOS, Android, Mac, Windows, Linux, Web
  • Flutter version: [e.g. 1.5.4]
  • Hive version: [e.g. 0.5.0]
@jbryanh jbryanh added the enhancement New feature or request label Feb 17, 2022
@julianklose
Copy link

The build_runner generated the adapter in .dart_tool/build/generated/ ... /test.hive_generator.g.part and the part of is missing. I have no idea how to reference it, so I ended up manually copying the generated adapter into my source file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants