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: fix mkEnableOption wording #438

Merged
merged 3 commits into from
Jan 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion modules/apps/ghostwriter.nix
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ in
{
options.programs.ghostwriter = {
enable = lib.mkEnableOption ''
Enable configuration management for Ghostwriter.
configuration management for Ghostwriter.
'';

font = lib.mkOption {
Expand Down
44 changes: 26 additions & 18 deletions modules/apps/kate/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ in
{
options.programs.kate = {
enable = lib.mkEnableOption ''
Enable configuration management for Kate, the KDE Advanced Text Editor.
configuration management for Kate, the KDE Advanced Text Editor.
'';

package =
Expand Down Expand Up @@ -450,23 +450,31 @@ in
example = "<>(){}[]'\"\`*_~";
description = "This options determines which characters kate will treat as brackets.";
};
automaticallyAddClosing = lib.mkEnableOption ''
When enabled, a closing bracket is automatically inserted upon typing the opening.
'';
highlightRangeBetween = lib.mkEnableOption ''
This option enables automatch highlighting of the lines between an opening and a
closing bracket when the cursor is adjacent to either.
'';
highlightMatching = lib.mkEnableOption ''
When enabled, and the cursor is adjacent to a closing bracket, and the corresponding
closing bracket is outside of the currently visible area, then the line of the opening
bracket and the line directly after will be shown in a small, floating window
at the top of the text area.
'';
flashMatching = lib.mkEnableOption ''
When this option is enabled, then a bracket will quickly flash whenever the cursor
moves adjacent to the corresponding bracket.
'';
automaticallyAddClosing = lib.mkEnableOption "" // {
description = ''
When enabled, a closing bracket is automatically inserted upon typing the opening.
'';
};
highlightRangeBetween = lib.mkEnableOption "" // {
description = ''
This option enables automatch highlighting of the lines between an opening and a
closing bracket when the cursor is adjacent to either.
'';
};
highlightMatching = lib.mkEnableOption "" // {
description = ''
When enabled, and the cursor is adjacent to a closing bracket, and the corresponding
closing bracket is outside of the currently visible area, then the line of the opening
bracket and the line directly after will be shown in a small, floating window
at the top of the text area.
'';
};
flashMatching = lib.mkEnableOption "" // {
description = ''
When this option is enabled, then a bracket will quickly flash whenever the cursor
moves adjacent to the corresponding bracket.
'';
};
};

# ==================================
Expand Down
2 changes: 1 addition & 1 deletion modules/apps/konsole.nix
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ in
{
options.programs.konsole = {
enable = lib.mkEnableOption ''
Enable configuration management for Konsole, the KDE Terminal.
configuration management for Konsole, the KDE Terminal.
'';

defaultProfile = lib.mkOption {
Expand Down
6 changes: 4 additions & 2 deletions modules/apps/okular.nix
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ with lib.types;
{
options.programs.okular = {
enable = lib.mkEnableOption ''
Enable configuration management for okular.
configuration management for okular.
'';

package =
Expand Down Expand Up @@ -140,7 +140,9 @@ with lib.types;
};

changeColors = {
enable = lib.mkEnableOption "Whether to change the colors of the documents.";
enable = lib.mkEnableOption "" // {
description = "Whether to change the colors of the documents.";
};
mode = lib.mkOption {
description = "Mode used to change the colors.";
default = null;
Expand Down
2 changes: 1 addition & 1 deletion modules/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@
];

options.programs.plasma.enable = lib.mkEnableOption ''
Whether to enable declarative configuration options for the KDE Plasma Desktop.
declarative configuration options for the KDE Plasma Desktop.
'';
}
4 changes: 3 additions & 1 deletion modules/files.nix
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,9 @@ in
Configuration files which explicitly should not be deleted on each generation, if `overrideConfig` is enabled.
'';
};
immutableByDefault = lib.mkEnableOption "Make keys written by plasma-manager immutable by default.";
immutableByDefault = lib.mkEnableOption "" // {
description = "Whether to make keys written by plasma-manager immutable by default.";
};
};

imports = [
Expand Down
2 changes: 1 addition & 1 deletion modules/panels.nix
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ let
Plasma 6-only.
'';
};
floating = lib.mkEnableOption "Enable or disable floating style.";
floating = lib.mkEnableOption "floating style.";
widgets = lib.mkOption {
type = lib.types.listOf widgets.type;
default = [
Expand Down
Loading