Docstrings.WithMenhir(3)

💅 NAME

Okay so bestie, Docstrings.WithMenhir — and the manpage literally says no description. That's it. That's the whole name section. Iconic of it to give us nothing, honestly. 🫠

---

🦋 Module

The module is called Docstrings.WithMenhir — that's the one we're talking about the whole way through, mwah. 💖

---

✨ Documentation ✨

Module WithMenhir

So this is a signature block — : sig end — and inside it there's a whole lil squad of vals. Here they all are, in order, no cap:

val symbol_docs : Lexing.position * Lexing.position -> Docstrings.docs

Grabs the item documentation for the symbol you're currently on. Bonus: it also marks that doc (for ambiguity warnings). Two birds, one slay. 🐦✨

val symbol_docs_lazy : Lexing.position * Lexing.position -> Docstrings.docs Lazy.t

Same shape as symbol_docs, but lazy — the manpage doesn't give it its own description, so we're not out here inventing lore. 🙈

val rhs_docs : Lexing.position -> Lexing.position -> Docstrings.docs

Gives you the item documentation for the symbols sitting between two positions. And yeah — it marks that documentation too (ambiguity warnings, you know the drill). 💅

val rhs_docs_lazy : Lexing.position -> Lexing.position -> Docstrings.docs Lazy.t

The lazy twin of rhs_docs. No description attached, so no guessing from me. 🎀

val mark_symbol_docs : Lexing.position * Lexing.position -> unit

Just marks the item documentation for the current symbol — for ambiguity warnings. Returns unit, so it's a vibe, not a value. 🫶

val mark_rhs_docs : Lexing.position -> Lexing.position -> unit

Marks the item documentation for the symbols between two positions as associated (for ambiguity warnings). 🏷️

val symbol_info : Lexing.position -> Docstrings.info

Fetches the field info for the current symbol. Info era. ⭐

val rhs_info : Lexing.position -> Docstrings.info

Fetches the field info following the symbol at a given position. Following, not preceding — read it carefully bestie. 👀

val symbol_text : Lexing.position -> Docstrings.text

Fetches the text preceding the current symbol. Pre, not post. 🌸

val symbol_text_lazy : Lexing.position -> Docstrings.text Lazy.t

Lazy version of symbol_text. No description given — moving on, our hands are clean. 🧚

val rhs_text : Lexing.position -> Docstrings.text

Fetches the text preceding the symbol at the given position. Same energy, position-flavoured. 🌈

val rhs_text_lazy : Lexing.position -> Docstrings.text Lazy.t

And the lazy one. Again — no description. We respect the mystery. 💀

---

🎀 Extra text 🎀

Lowkey the cutest part. There might be additional text attached to the delimiters of a block (think struct and end — yes, exactly like those). These next functions fetch it, and here's the important bit: they're applied to the contents of the block, not the delimiters themselves. Big distinction, don't fumble it. ✨

val symbol_pre_extra_text : Lexing.position -> Docstrings.text

Fetches additional text preceding the current symbol. 🦋

val symbol_post_extra_text : Lexing.position -> Docstrings.text

Fetches additional text following the current symbol. 🦋

val rhs_pre_extra_text : Lexing.position -> Docstrings.text

Fetches additional text preceding the symbol at the given position. 🍓

val rhs_post_extra_text : Lexing.position -> Docstrings.text

Fetches additional text following the symbol at the given position. 🍓

val rhs_post_text : Lexing.position -> Docstrings.text

Fetches text following the symbol at the given position. Note this one's just rhs_post_text — no extra in the name, don't come for me, that's literally what it says. 👑 🔥

---

🌟 Reminder bestie: symbol_pre_extra_text / symbol_post_extra_text / rhs_pre_extra_text / rhs_post_extra_text / rhs_post_text are all about the contents of the block, not the delimiters. Say it with me. 💜

---

That's the whole page, fr fr. Generated with OCamldoc, dated 2026-06-22, and that's Docstrings.WithMenhir(3) signing off — section 3 of the manual, mwah, bye bestie! 💖🎀🦋