doc: add documentation to __addErrorContext primop#15817
Open
Zocker1999NET wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR makes builtins.addErrorContext show up in the builtins reference manual by adding argument names (.args) and a documentation string (.doc) to the underlying __addErrorContext primop registration.
Changes:
- Add
.args = {"context", "value"}for the__addErrorContextprimop. - Add a Markdown
.docblock (including an example) describingaddErrorContext.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Zocker1999NET
force-pushed
the
doc-addErrorContext
branch
from
843e015 to
a4e691d
Compare
roberth
reviewed
May 9, 2026
This adds .args and .doc fields to the primop registration for __addErrorContext, making it appear in the builtins reference manual.
Zocker1999NET
force-pushed
the
doc-addErrorContext
branch
from
a4e691d to
3fd52d9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds .args and .doc fields to the primop registration for __addErrorContext, making it appear in the builtins reference manual.
Motivation
more documentation -> more good
The issue is known since 2017 & I really think this function should be documented as it is helpful for making your own Nix expressions easier to debug.
Context
fixes #1609
I tried to use a similar documentation format already used on similar "side-effect" wrappers like
warn.Add 👍 to pull requests you find important.
The Nix maintainer team uses a GitHub project board to schedule and track reviews.