Skip to content

Commit

Permalink
lib/modules: hide _module.args docs
Browse files Browse the repository at this point in the history
unfortunately we can't unconditionally make this text markdown without
impacting downstream users of docs generation (as noted in #175586).
hide it entirely until the transition is complete.
  • Loading branch information
pennae committed Jan 5, 2023
1 parent 9da5f12 commit e912c7b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions lib/modules.nix
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,11 @@ rec {
${if prefix == []
then null # unset => visible
else "internal"} = true;
# TODO: hidden during the markdown transition to not expose downstream
# users of the docs infra to markdown if they're not ready for it.
# we don't make this visible conditionally because it can impact
# performance (https://github.com/NixOS/nixpkgs/pull/208407#issuecomment-1368246192)
visible = false;
# TODO: Change the type of this option to a submodule with a
# freeformType, so that individual arguments can be documented
# separately
Expand Down

0 comments on commit e912c7b

Please sign in to comment.