`papyri.directives:role_unset`

source: /papyri/directives.py:84

Signature

def role_unset(value: str, *, role: str = ?, warn: DirectiveWarn = <function _log_warn at 0x0000>) → list[Any]

Summary

Placeholder role handler: renders like role_verbatim but warns.

Extended Summary

Map a project-local role to it to acknowledge the role exists without deciding its rendering yet — gen stays green (no W-unknown-role error), the role stays visible (a W-unset-role warning on every use), and the config string is easy to grep for when the real handler gets written

[global.roles]
mpltype = 'papyri.directives:role_unset'

Inside papyri gen the visitor binds role and warn so the warning carries the role name and reaches the Diagnostics collector.

Aliases

papyri.directives.role_unset