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

Default value for boolean isCacheDriverPerThread() is incorrect in API Docs #592

Closed
namuller30 opened this issue Sep 19, 2019 · 2 comments
Closed
Assignees
Labels
Milestone

Comments

@namuller30
Copy link

@namuller30 namuller30 commented Sep 19, 2019

The API docs (https://gebish.org/manual/current/api/) stated default value for isCacheDriverPerThread() is true. If you look at the code you can see that the actual default value is false.

    boolean isCacheDriverPerThread() {
        readValue('cacheDriverPerThread', false)
    }

The docs should be updated to say that the default value is false.

@namuller30
Copy link
Author

@namuller30 namuller30 commented Sep 19, 2019

Also looks like the documentation in the code is wrong in Configuration.groovy.

This got me thinking though wouldn't it make more sense for the default value of this property actually be false?

@erdi erdi closed this in 6bf3dc6 Sep 23, 2019
@erdi
Copy link
Member

@erdi erdi commented Sep 23, 2019

Thanks for reporting, @namuller30. I've fixed the mistake in the javadoc for that method which incorrectly stated that this configuration option is set to true by default.

@erdi erdi self-assigned this Sep 23, 2019
@erdi erdi added this to the 3.1 milestone Sep 23, 2019
@erdi erdi added the Manual label Sep 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants