Skip to content
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

docs: fully document nix library #413

Merged
merged 1 commit into from
Dec 20, 2024
Merged

docs: fully document nix library #413

merged 1 commit into from
Dec 20, 2024

Conversation

getchoo
Copy link
Member

@getchoo getchoo commented Dec 20, 2024

No description provided.

@getchoo
Copy link
Member Author

getchoo commented Dec 20, 2024

$ nix repl -f '<nixpkgs>'
Nix 2.25.3
Type :? for help.
Loading installable ''...
Added 23259 variables.
nix-repl> catppuccinLib = import ./modules/lib { config = { }; inherit lib pkgs; }

nix-repl> :doc catppuccinLib.mkCatppuccinOption
Function mkCatppuccinOption
    … defined at /home/seth/repos/ctp-nix/modules/lib/default.nix:186:5

    Creates an attribute set of standard Catppuccin module options

Example

      | mkCatppuccinOption { name = "myProgram"; }

Type

      | mkCatppuccinOption :: AttrSet -> AttrSet

Arguments

      · [name] Name of the module
      · [useGlobalEnable] Whether to enable the module by default when catppuccin.enable is set (recommended, defaults to true)
      · [default] Default enable option value (defaults to if useGlobalEnable then config.catppuccin.enable else false)
      · [defaultText] Default enable option text (automatic if null, defaults to if useGlobalEnable then "config.catppuccin.enable" else null)
      · [accentSupport] Add an accent option (defaults to false)

@getchoo getchoo merged commit 5501cb5 into main Dec 20, 2024
6 checks passed
@getchoo getchoo deleted the getchoo/docstrings branch December 20, 2024 20:28
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