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 don't make location of GhApi clear #26

Closed
henryiii opened this issue Dec 21, 2020 · 1 comment
Closed

Docs don't make location of GhApi clear #26

henryiii opened this issue Dec 21, 2020 · 1 comment

Comments

@henryiii
Copy link

henryiii commented Dec 21, 2020

I could not figure out where GhApi came from just by reading the docs, I tried ghapi.GhApi, I tried dir(ghapi), and no sign of it. I clicked through a bit and didn't see it either. Finally found it by entering colab and seeing the ghapi.core import at the top that gets hidden. Two recommendations:

  • Somewhere in the docs mention that ghapi.core is the home for GhApi.
  • Use qualified references in the docs. import * makes docs really hard to follow (especially when it's then hidden! But even not hidden it is bad in docs). Since most operations are on the ghapi.core.GhApi object, it won't make the docs that much more verbose, and would be much easier to follow.

PS: It's also missing from the readme.

@hamelsmu
Copy link
Member

Added this to the README/docs

from ghapi.all import GhApi

cc: @jph00

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