Documentation for the possible arguments of progressr updates

[martinmodrak]

From the docs of progressr one can infer that we can provide several arguments to updates sent with progressr:

• msg or message for a text string to display
• amount for the amount of progress made
• class = "sticky" to have a message stick around

However, 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 type and time)

Is there a place where those are documented that I missed?

[HenrikBengtsson]

Is there a place where those are documented that I missed?

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.