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

Please consider updating the doc #17

Open
toyssamurai opened this issue Nov 11, 2020 · 1 comment
Open

Please consider updating the doc #17

toyssamurai opened this issue Nov 11, 2020 · 1 comment

Comments

@toyssamurai
Copy link

It took me almost 30 mins to find out how to specify the host. The doc gives the following sample codes:

final c = CouchDbClient(username: 'name', password: 'pass');

Throughout the entire documentation, there's no mentioning of setting the host address. Even the example shows nothing about setting the host.

Yes, it's in the API doc of the CouchDbClient class and the test codes, but not having it in the main doc is very confusing.

@bean5
Copy link

bean5 commented Mar 6, 2021

@YevhenKap I agree that updating the documentation could be helpful in relation to this.

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

2 participants