Improve documentation of the Memcached delete methods #1957
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
tstarling
commented
Nov 7, 2022
tstarling
commented
- Note that it's always an error to specify a non-zero time parameter, and delete the long-winded explanations of what it is meant to do.
- Expand the description of the return value from deleteMulti().
- Replace the incorrect description of the return value of deleteMultiByKey(). Use the one from deleteMulti() instead.
- Explain what getResultCode() will return after deleteMulti().
* Note that it's always an error to specify a non-zero time parameter, and delete the long-winded explanations of what it is meant to do. * Expand the description of the return value from deleteMulti(). * Replace the incorrect description of the return value of deleteMultiByKey(). Use the one from deleteMulti() instead. * Explain what getResultCode() will return after deleteMulti().
cmb69
reviewed
Nov 7, 2022
| <!ENTITY memcached.result.delete-multi '<para xmlns="http://docbook.org/ns/docbook"> | ||
| Returns an array indexed by <parameter>keys</parameter>. Each element | ||
| is &true; if the corresponding key was deleted, or one of the | ||
| <constant>Memcached::RES_*</constant> constants if the corresponding deletion |
There was a problem hiding this comment.
If #1963 will be merge, this should be:
Suggested change
| <constant>Memcached::RES_*</constant> constants if the corresponding deletion | |
| <constant><replaceable>Memcached::RES_*</replaceable></constant> constants if the corresponding deletion |
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
Girgias
reviewed
Nov 10, 2022
language-snippets.ent
Outdated
| <!ENTITY memcached.note.delete-time '<note xmlns="http://docbook.org/ns/docbook"><simpara> | ||
| As of memcached 1.3.0 (released 2009) this feature is no longer | ||
| supported. Passing a non-zero <parameter>time</parameter> will cause | ||
| libmemcached to raise an error. |
There was a problem hiding this comment.
Do we know what sort of error is raised? Is it an exception an E_WARNING, an E_NOTICE something else?
There was a problem hiding this comment.
Sorry, that is unclear, I will improve it. The library has its own error handling. $memcached->delete() will return false and $memcached->getResultCode() returns MEMCACHED_INVALID_ARGUMENTS. No PHP error is raised.
Girgias
approved these changes
Nov 12, 2022
|
Am I permitted to self-merge now that it has an approval? |
Yes, sorry. The process here is for the most part to self merge, but if you don't want we can do it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.