furrr_options documentation doesn't say what to do with it

[debarros]

The documentation at https://furrr.futureverse.org/reference/furrr_options.html (which I believe is generated by the file https://github.com/DavisVaughan/furrr/blob/main/R/furrr-options.R) does not indicate what sort of object the function returns, or what to do with that object. I initially thought I simply needed to run that function with my desired settings to invisibly provide furrr with options thet it would use whenever a furrr function was called. By exploring elsewhere, I was eventually able to figure out thet it produces an object thet can be passed to furrr functions. I'm personally all set on this now, but I think others would be helped if the documentation were a bit more explicit about it. Perhaps the Examples section could be expanded to show a furrr_options object being passed to something like future_map. I'd offer to fork, modify, and submit a pull request, but I just started using furrr a few days ago and would probably produce garbage code and documentation.