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

joi.dev documentation shows newer information that hasn't been released yet. #2870

Closed
ZachHaber opened this issue Oct 31, 2022 · 2 comments
Closed
Assignees
Labels
documentation Non-code related changes

Comments

@ZachHaber
Copy link

Context

  • 16.7.0:
  • 17.6.4:

What are you trying to achieve or the steps to reproduce ?

I was looking at the documentation and found isPresent as an option for the with and other key/peer object validations.

I had attempted to use it, and was incredibly confused when I got this error message:

Error: Options contains unknown keys: isPresent

It wasn't until I was searching through the github to get a bug report together until I realized that the reason it doesn't work is because the PR for it was just merged in (#2762), and version 17.7.0 that it's been tagged for hasn't been released yet.

image


If possible, new features shouldn't show in the documentation automatically until the feature is released, especially when the on the "current" version on the version selector, and not a next or beta documentation channel.

@ZachHaber ZachHaber added the documentation Non-code related changes label Oct 31, 2022
@Marsup Marsup self-assigned this Nov 1, 2022
@Marsup
Copy link
Collaborator

Marsup commented Nov 1, 2022

Thanks for the warning. The version is now published, I'll take care of the website glitch later.

@Marsup Marsup closed this as completed Nov 1, 2022
@ZachHaber
Copy link
Author

I wanted to also note that https://joi.dev/tester/ doesn't seem to be using the latest package version, and is rejecting the new isPresent option.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Non-code related changes
Projects
None yet
Development

No branches or pull requests

2 participants