Skip to main content

ORDER_AFTER_TOPIC_BLOCKS

Constant ORDER_AFTER_TOPIC_BLOCKS 

Source
pub(crate) const ORDER_AFTER_TOPIC_BLOCKS: &str = "@order NaN";
Expand description

The @order tag that sorts a generated block after every block without one, so the topic’s own block claims a merged page regardless of R file order (#1590).

roxygen2 gives a merged page the \name and \title of the first block it reads, and every block contributes a \name (a @describeIn block too, from its object), so dropping generated titles cannot fix the page name. Blocks are read in order_blocks() order: every block of the package sorted with order(as.double(<@order>)), Inf for a block without @order, which is stable and puts NaN last. A generated block that joins an author topic therefore sorts after the author’s block wherever the R files sit, and the generated blocks of one topic keep their source order among themselves (a topic made only of generated blocks renders as before). On a merged page a later block’s @param wins, which is why joining blocks also drop their generated @param lines.