Documentation of RNTupleWriter / RNTuple could be improved a bit #19168
Description
Explain what you would like to see improved and how.
RNTupleWriter
I tried to find out what RNTupleWriter::Append is supposed to do. Please see the current state that would need more information:
https://root.cern.ch/doc/master/classROOT_1_1RNTupleWriter.html#a7cbb027b0733b166da1b9c818fd90e2e
A similar extension could be done for Recreate.
Finally, the overview of the class at the top of the doxygen page starts by talking about RNTuple, but not about the writer. One could start maybe by saying something like:
RNTupleWriter is a user interface for writing RNTuples to disc. Users can instantiate writers using the functions Append and Recreate (ensure that doxygen links) while providing an RNTupleModel that defines the fields/columns to be written.
And then go on to explain how to assign values to fields and trigger the writes. This could be finished off with a minimal code example and/or a link to a tutorial.
RNTuple
Looking at the top of https://root.cern.ch/doc/master/classROOT_1_1RNTuple.html, I believe this is not what users want to see if they look for "RNTuple". Although what is described there is formally correct, they probably wanted to know how to read or write an RNT. So maybe one could extend the documentation to:
ROOT::RNTupleis the representation of an RNTuple data set in a ROOT file.
- To read an RNTuple, see RNTupleReader or use RDataFrame
- To write an RNTuple, see RNTupleWriter
and from here continue the documentation of RNTuple.
ROOT version
6.36, master
Installation method
--
Operating system
--
Additional context
No response