document return value of package_coverage?

[tdhock]

Hi, first of all thanks for maintaining covr, which I find very useful. I am trying to compute coverage of a source package locally (not on githu actions), and I think package_coverage will do what I want, because there is some discussion in https://github.com/r-lib/covr?tab=readme-ov-file#interactively

I expected ?package_coverage to have a Value section which documents what is the returned value, but I observe that there is no such documentation. Can it be added please? In particular I would like to know what is the structure of the returned object, and how I can get a data structure (data.frame?) describing what lines in what files are covered.

Thanks in advance!