style: use glue for line-wrapping in cache warnings #191
Conversation
| "i" = "disabling the cache for this session with `disable_cache` or | ||
| permanently with environmental variable `EPIDATR_USE_CACHE=FALSE`", | ||
| "i" = "setting `EPIDATR_CACHE_MAX_AGE_DAYS={Sys.getenv('EPIDATR_CACHE_MAX_AGE_DAYS | ||
| ', unset = 1)}` to e.g. `3/24` (3 hours)." |
There was a problem hiding this comment.
todo: This rendered as ℹ setting `EPIDATR_CACHE_MAX_AGE_DAYS=1` to e.g. `3/24` (3 hours). for me. Tweak to remove or reword the =1. [hopefully fixed the GitHub formatting]
There was a problem hiding this comment.
I think that was intended, to show the current value? though it does look like github is treating the ` strangely.
There was a problem hiding this comment.
maybe we reword it for clarity?
setting `EPIDATR_CACHE_MAX_AGE_DAYS` (currently {Sys.getenv('EPIDATR_CACHE_MAX_AGE_DAYS'
, unset = 1)}) to e.g. `3/24` (3 hours)
There was a problem hiding this comment.
slight tweak, maybe
setting environment variable `EPIDATR_CACHE_MAX_AGE_DAYS` (currently {Sys.getenv('EPIDATR_CACHE_MAX_AGE_DAYS', unset = 1)}) to e.g. `3/24` (3 hours)
(btw, Sys.getenv's unset parameter will be stringified. Don't think it matters here but I thought I saw some hints of surprise due to this somewhere in the code.)
There was a problem hiding this comment.
it might also benefit from some extra explanation what it's doing, making sure that they receive any new versions of versions quickly (but with better wording)
| " to e.g. `3/24` (3 hours)." | ||
| "Using cached results with `as_of` within the past week (or the future!). | ||
| This will likely result in an invalid cache. Consider", | ||
| "i" = "disabling the cache for this session with `disable_cache` or |
There was a problem hiding this comment.
comment: "i" = is "info item", not numbered list, if that was what you were expecting. Here it might look prettier to use "*" for a bulleted list. (Not sure how to do an actual enumeration, but here just an unordered list seems more suitable.)
No description provided.