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 / README #531

Open
yymao opened this issue Dec 29, 2020 · 0 comments
Open

Improve documentation / README #531

yymao opened this issue Dec 29, 2020 · 0 comments

Comments

@yymao
Copy link
Member

yymao commented Dec 29, 2020

We can use a more thorough review of the current documentation (in particular, README.md on the front page), adding references to the public functions that we recently introduced in GCRCatalogs.register and their recommended usages.

Also, in lieu of a webpage that lists the public API, we can point the users to using help(GCRCatalogs.register) to see the list of public functions.

Other suggestions to improve the documentation / README are also welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant