You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
I could not figure out where
GhApi
came from just by reading the docs, I triedghapi.GhApi
, I trieddir(ghapi)
, and no sign of it. I clicked through a bit and didn't see it either. Finally found it by enteringcolab
and seeing theghapi.core
import at the top that gets hidden. Two recommendations:ghapi.core
is the home for GhApi.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 theghapi.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.
The text was updated successfully, but these errors were encountered: