Skip to content

fix defaultText for pkgs option using literalMD #350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 2, 2025

Conversation

MattSturgeon
Copy link
Contributor

Passing a non-literal string to example or defaultText causes the docs to render the value using lib.generators.toPretty.

If you want to use markdown, use literalMD. If you want to pass a nix expression, use literalExpression.

@zimbatm zimbatm enabled auto-merge (squash) May 2, 2025 07:38
@zimbatm
Copy link
Member

zimbatm commented May 2, 2025

thanks! do you mind rebasing the change?

Passing a non-literal string to `example` or `defaultText` causes the
docs to render the value using `lib.generators.toPretty`.

If you want to use markdown, use `literalMD`. If you want to pass a nix
expression, use `literalExpression`.
auto-merge was automatically disabled May 2, 2025 12:56

Head branch was pushed to by a user without write access

@MattSturgeon
Copy link
Contributor Author

thanks! do you mind rebasing the change?

Done 👍

@zimbatm zimbatm merged commit 29ec502 into numtide:main May 2, 2025
3 checks passed
@zimbatm
Copy link
Member

zimbatm commented May 2, 2025

thanks!

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.

2 participants