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

Documentation: Syntax error in Github.create #224 #225

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Black-Smith-Of-Fire
Copy link

While trying the api, I found the documentation to contain errors regarding the create method of the GithubClient. I hope this small edit would help others to avoid the similar problems

Copy link
Member

@Abhi347 Abhi347 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The method is defined as

public static GitHubClient create(final URI baseUrl, final File privateKey, final Integer appId){}

There's no create overload (AFAIK) which accepts URI for the private key. There's one which takes byte[] instead.
Can you show the code where we are accepting URI instead of File?

@Black-Smith-Of-Fire
Copy link
Author

I see what you mean at line number 191 in the com.spotify.github.v3.clients.GitHubClient class, but why can't I pass File in the second parameter ? Line number 179 is the create overload that I am talking about. We are using version number 0.4.1, right ?

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

Successfully merging this pull request may close these issues.

2 participants