Skip to content

docs: don't remove freeform sub-options #3244

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.

Sign up for GitHub

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
Apr 29, 2025
Merged

docs: don't remove freeform sub-options #3244

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/mdbook/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,19 @@ let

removeUnwanted =
attrs:
builtins.removeAttrs attrs [
# FIXME: We incorrectly remove _freeformOptions here.
#
# However we can't fix the bug because we derive page names from attrnames;
# the correct behaviour would be to ignore attrnames and use option locs.
#
# As a workaround, merge the freeform options at the top of these attrs,
# however this can run into name conflicts 😢
#
# We should move this workaround to where we decide the page name and
# whether to nest into a sub-page, so that we can keep the original
# _freeformOptions attr as intended.
attrs._freeformOptions or { }
// builtins.removeAttrs attrs [
"_module"
"_freeformOptions"
"warnings"
Expand Down