Skip to content

Commit 9ceee38

Browse files
committed
[TDF] Fix/rephrase documentation for the parameters of the Range action
1 parent 5ae05f8 commit 9ceee38

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

tree/treeplayer/inc/ROOT/TDFInterface.hxx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -749,11 +749,12 @@ public:
749749
}
750750

751751
////////////////////////////////////////////////////////////////////////////
752-
/// \brief Creates a node that filters entries based on range
753-
/// \param[in] start How many entries to discard before resuming processing.
754-
/// \param[in] stop Total number of entries that will be processed before stopping. 0 means "never stop".
755-
/// \param[in] stride Process one entry every `stride` entries. Must be strictly greater than 0.
752+
/// \brief Creates a node that filters entries based on range: [start, stop)
753+
/// \param[in] begin Initial entry number considered for this range.
754+
/// \param[in] end Final entry number (excluded) considered for this range. 0 means that the range goes until the end of the dataset.
755+
/// \param[in] stride Process one entry of the [begin, end) range every `stride` entries. Must be strictly greater than 0.
756756
///
757+
/// Note that in case of previous Ranges and Filters the selected range refers to the transformed dataset.
757758
/// Ranges are only available if EnableImplicitMT has _not_ been called. Multi-thread ranges are not supported.
758759
TInterface<TDFDetail::TRange<Proxied>> Range(unsigned int start, unsigned int stop, unsigned int stride = 1)
759760
{

0 commit comments

Comments
 (0)