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

Improve documentation by add links in the methods description. #26

Open
cheqianh opened this issue Jan 24, 2023 · 0 comments
Open

Improve documentation by add links in the methods description. #26

cheqianh opened this issue Jan 24, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@cheqianh
Copy link
Contributor

cheqianh commented Jan 24, 2023

In short, Customers should find documentation for desired methods easily.

In details, The documentation should have a link from specific method (E.g., withSearchPath). How do users invoke this method with expected syntax? We know the documentation is here but people who are new to the library probably not.

@cheqianh cheqianh added the enhancement New feature or request label Jan 24, 2023
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

1 participant