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

Wrong function name in refresh token documentation #825

Closed
xintellion opened this issue May 19, 2020 · 5 comments
Closed

Wrong function name in refresh token documentation #825

xintellion opened this issue May 19, 2020 · 5 comments
Labels
docs Issues that involve improving or adding documentation. pr-welcome We'd welcome a PR to solve the issue.

Comments

@xintellion
Copy link

Describe the bug
Documentation improvement

To Reproduce
Steps to reproduce the behavior:

  1. Go to 'https://manfredsteyer.github.io/angular-oauth2-oidc/docs/additional-documentation/refreshing-a-token.html'

Expected behavior
The function name refrenced in the documentation should match the name in the code

Additional context
In the document the function name for refreshing a token seems to be wrong
this.oauthService.refresh();
I think it should be:
this.oauthService.refreshToken();

@jeroenheijmans jeroenheijmans added docs Issues that involve improving or adding documentation. pr-welcome We'd welcome a PR to solve the issue. labels May 19, 2020
@jeroenheijmans
Copy link
Collaborator

Think you're right, there seems to only be a refreshToken() method on the service.

@xintellion
Copy link
Author

@jeroenheijmans will provide a PR

xintellion pushed a commit to xintellion/angular-oauth2-oidc that referenced this issue Jun 14, 2020
Wrong function name in refresh token documentation
xintellion pushed a commit to xintellion/angular-oauth2-oidc that referenced this issue Jun 14, 2020
Wrong function name in refresh token documentation
@xintellion
Copy link
Author

@jeroenheijmans created a PR

@jeroenheijmans
Copy link
Collaborator

Thx!

Note that it's typically the core maintainer to merge a bunch of PRs at once, every once in a while, so it might take a bit.

@jonyeezs
Copy link

jonyeezs commented Oct 3, 2020

pinging to notify this can be closed (if forgotten)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues that involve improving or adding documentation. pr-welcome We'd welcome a PR to solve the issue.
Projects
None yet
Development

No branches or pull requests

3 participants