Skip to content

Commit ae83f2d

Browse files
committed
auth: document usability of both Client and App ID for token generation
1 parent a0aeef8 commit ae83f2d

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

src/simple_github/auth.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,12 @@ async def get_token(self) -> str:
5050

5151

5252
class AppAuth(Auth):
53-
def __init__(self, app_id: int | str, privkey: str):
53+
def __init__(self, app_id: str | int, privkey: str):
5454
"""Authentication for a Github app.
5555
5656
Args:
57-
id (int or str): The Github app id.
57+
app_id (str or int): The Github Client (str) or App (int) ID. GitHub
58+
recommends using the Client ID.
5859
privkey (str): A base64 encoded private key associated with the
5960
app.
6061
"""

0 commit comments

Comments
 (0)