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
docs: Fix typos in libraries/caching.rst #8846
base: develop
Are you sure you want to change the base?
Conversation
Fix typos in libraries/caching.rst
Fix sentence in File-based Caching in libraries/caching.rst
Change some decorations libraries/caching.rst
Remove $raw parameter from save method in libraries/caching.rst
|
||
$backupHandler | ||
============== | ||
|
||
In the case that the first choice ``$handler`` is not available, this is the next cache handler to load. | ||
This is commonly the ``File`` handler since the file system is always available, but may not fit | ||
more complex, multi-server setups. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do you remove this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kenjis Because in the code backupHandler is 'dummy'.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Revert this change or update the description.
It is just the default value is dummy
.
It explains file
is often used for backup.
|
||
$backupHandler | ||
============== | ||
|
||
In the case that the first choice ``$handler`` is not available, this is the next cache handler to load. | ||
This is commonly the ``File`` handler since the file system is always available, but may not fit | ||
more complex, multi-server setups. | ||
The default backup handler is **dummy**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we need to add this?
Dummy is not a real cache handler. It does not cache anything.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kenjis $backupHandler is different in User guide and App/Config/Cache.php file. I tried to make them the same. Guide says $backupHandler is File but code has $backupHandler = 'dummy'. How should we match them? $handler = 'file', $backupHandler = 'dummy' in the code. Making two of them 'file' is a bit meaningless.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The user guide does not say about the default backup handler.
The default $backupHandler
should be dummy
. Because it never fails to initialize.
And it does not cache anything, so it is the same as not using cache.
In real apps, it is often file
and the primary cache is memcached
or redis
.
Because file can be used in most environments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kenjis "The user guide does not say about the default backup handler."
Then I misunderstood this part "This is commonly the File handler". So, it means that we cannot match the user guide to code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. If it is a bit difficult to understand,
- show that the default handler is dummy
- explain that file handler is often used
Remove mistakenly changed sentence in libraries/caching.rst
Updated File-based Caching in libraries/caching.rst
Description
Fix typos in libraries/caching.rst
Checklist: