Skip to content

Conversation

@jplatte
Copy link
Member

@jplatte jplatte commented Oct 31, 2025

WIP (actual docs not written, CLI output not yet updated)
Closes #376.

@ermo
Copy link
Member

ermo commented Nov 2, 2025

@jplatte Per our understanding, the first pass of the defined-in-code internal macro documentation strings are now up for you to attempt to display via boulder recipe macros.

@jplatte jplatte marked this pull request as ready for review November 2, 2025 20:42
@ermo
Copy link
Member

ermo commented Nov 2, 2025

@jplatte:

Built-in definitions should be shown as %(name), not %name. Is this easy to change for you?

For context, think of %(definition) as a "constant" and %action as a "sub-routine" with a side-effect. This is of course entirely by convention for readability's sake.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

boulder: Make boulder's own code (i.e. outside of external .yaml fields) self-documenting re. macros

2 participants