doc: documented the shdict:ttl() and shdict:expire() API functions. #1157
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
thibaultcha
commented
Sep 21, 2017
|
|
||
| **context:** *init_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua** | ||
|
|
||
| **requires:** `resty.core.shdict` or `resty.core` |
There was a problem hiding this comment.
My initial idea is to introduce this new requires section to make this obvious early in the reading of this method's documentation. There is also a note at the bottom of it with a link to the lua-resty-core library. Open to suggestions!
There was a problem hiding this comment.
@thibaultcha That's fine, though we'll soon make lua-resty-core mandatory and loaded by default in the next ngx_lua release anyway :)
There was a problem hiding this comment.
@agentzh Yeah - I remember :) Alright then!
|
@thibaultcha Yes, please :) |
agentzh
approved these changes
Sep 21, 2017
|
@thibaultcha Merged. Thanks! |
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.
A first pass at documenting the new shm methods introduced in openresty/lua-resty-core#140.
Kind of exploring new territories here since I don't think any API in this documentation refers to a
resty.core-only API yet. I am open to suggestions on how to reflect that as best as possible in the docs!