Documentation for the possible arguments of progressr updates #824
martinmodrak
started this conversation in
General
Replies: 1 comment
The ones you've listed are the ones that are considered stable and part of the public API. Everything else is "internal only". Also, the philosophy is to overtime identify what should go into a "progress reporting" API that can be supported by all current (and future) progress handlers. The current set is minimal, because those arguments are the only ones I'm quite certain can be support everywhere. |
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
From the docs of
progressrone can infer that we can provide several arguments to updates sent withprogressr:msgormessagefor a text string to displayamountfor the amount of progress madeclass = "sticky"to have a message stick aroundHowever, the code appears to support a bunch of other options, that appear documented at https://github.com/futureverse/progressr/blob/develop/R/progression.R but that documentation does not appear on the web... (like
typeandtime)Is there a place where those are documented that I missed?
All reactions