8000 Documentation is incorrect / refers to changes not yet in dev-master · Issue #125 · lcobucci/jwt · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Documentation is incorrect / refers to changes not yet in dev-master #125

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.

Sign up for GitHub

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

Jump to bottom
Closed
gramorris opened this issue Oct 17, 2016 · 8 comments
Closed

Documentation is incorrect / refers to changes not yet in dev-master #125

gramorris opened this issue Oct 17, 2016 · 8 comments
Labels
Documentation
Milestone
4.0.0-alpha1

Comments

@gramorris
Copy link

We're running latest dev-master version (972cfe0) and as part of the update changed the Configuration method names to issuedBy & canOnlyBeUsedBy etc.

The documentation shows the same changes for ValidationData however the ValidationData code is still using the old methods setIssuer and setAudience - using issuedBy & canOnlyBeUsedBy results in a "Call to undefined method Lcobucci\JWT\ValidationData::issuedBy()"
@renatomefi
Copy link

Hello @gramorris, thanks for the report! The dev-master is current part of a refactor to make a new major version, It's not advised to use it yet! @lcobucci please correct me if I'm wrong!
Do you have an specific reason to use that version?

@gramorris
Copy link
Author

@renatomefi thanks, we didn't see anywhere where it says it's not advised to use it, it's worked and is working fine for us. I just felt it was worth pointing out that the documentation on the project homepage is incorrect as per the current commit.

@schnittstabil
Copy link
schnittstabil commented Oct 19, 2016 •
edited
Loading

we didn't see anywhere where it says it's not advised to use it

@renatomefi @gramorris Sorry, but that's assumed to be common knowledge, composer also installs the latest stable release:
image

I just felt it was worth pointing out that the documentation on the project homepage is incorrect as per the current commit.

Even though master is a development branch and not a release branch, the readme.md on master should match the current state of master (known as iterative incremental development) – hence thank you for pointing that out 👍 – However master was deployed/released only to jwt contributors, thus inconsistencies have to be expected.

@renatomefi
Copy link
renatomefi commented Oct 19, 2016 •
edited
Loading

@schnittstabil do you mean tagging me or the issue author? :)

Thanks for making it clear though! Also agree in keeping the documentation up to date, I'm just worried the author was using master branch and it can be unsafe for now!

@gramorris
Copy link
Author

We're getting in to a discussion of semantics so I'll just say that what we assumed was the risks associated with using a dev-master branch, we were happy to proceed on that basis. There's no need to be worried on our behalf.

As the documentation for the dev-master is on the project homepage and is incorrect/inconsistent I felt it worth pointing out, that was all I was doing.

@renatomefi
Copy link

You did right! Thanks for it!

@lcobucci lcobucci added this to the 4.0.0 milestone Oct 20, 2016
@lcobucci
Copy link
Owner
lcobucci commented Oct 20, 2016 •
edited
Loading

WOW! Guys you're just awesome! Basically you're all right 😂

@gramorris thanks for pointing out about the doc, I'll fix it.
@renatomefi @schnittstabil thanks for helping people in this repo too 🍻

@gramorris is good to know that we have some early users, but mind the changes. I'm working on the validation refactor and that is going to be merged soon (https://github.com/lcobucci/jwt/tree/refactor/validator-extraction).

@gramorris
Copy link
Author

Thanks @lcobucci , appreciate the work on the library, we've not found any issues with the functionality so far 👍

Horikawaer pushed a commit to Horikawaer/jwt that referenced this issue Nov 3, 2022
@lcobucci
Revert changes on validation documentation
b3768c9 
On lcobucci/jwt#119 we changed unrelated things on the documentation and this
fixes lcobucci/jwt#125.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
4.0.0-alpha1
Development

No branches or pull requests
4 participants
@lcobucci @renatomefi @schnittstabil @gramorris
0