Skip to content

Commit

Permalink
Add .editorconfig, adjust docs
Browse files Browse the repository at this point in the history
We assume an 80-column terminal as a conservative default.
Having at least 2 blank columns at the end of a line helps readability
(for understanding that a line has ended and hasn't been cut off).
However, paragraphs are indented 2 spaces in the built-in help,
leaving a limit of 76 columns.
  • Loading branch information
TheDaemoness committed Dec 18, 2023
1 parent b2dc663 commit 1ddcbba
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 10 deletions.
14 changes: 14 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
root = true

[doc/*.adoc]
end_of_line = lf
max_line_length = 76
insert_final_newline = true
trim_trailing_whitespace = true
charset = utf-8

[*.hs]
indent_size = 2
indent_style = space
tab_width = 8

2 changes: 1 addition & 1 deletion doc/cmds_chanop.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ See also: kick, kickban

View or set the topic of the current channel.

Tab-completion with no `message` specified will load the current topic for editing.
Tab-completion with no `message` specified will load the current topic.
9 changes: 6 additions & 3 deletions doc/cmds_integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,18 @@

Send command directly to ZNC.

The advantage of this over `+/msg+` is that responses are not broadcast to call clients.
The advantage of this over `+/msg+` is that
responses are not broadcast to call clients.

== /znc-playback

Request playback from the ZNC `playback` module.
Note that the playback module is not installed in ZNC by default!

When `date` is omitted, uses the most recent date in the past that makes sense.
When both `time` and `date` are omitted, all playback is requested.
When `date` is omitted,
uses the most recent date in the past that makes sense.
When both `time` and `date` are omitted,
all playback is requested.

Time format: `HOURS:MINUTES` (example: 7:00)

Expand Down
15 changes: 9 additions & 6 deletions doc/cmds_window.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@ See also: query, channel

Clear a window.

If no arguments are provided the current window is cleared.
If `network` is provided the that network window is cleared.
If `network` and `channel` are provided that chat window is cleared.
If `network` is provided and `channel` is `*` all windows for that network are cleared.
If no arguments are provided, the current window is cleared.
If `channel` is not provided, the `network` window is cleared.
If `channel` is `*`, all windows for `network` are cleared.
If `channel` is provided, that chat window is cleared.

If a window is cleared and no longer active that window will be removed from the client.
If a window is cleared and no longer active (e.g. due to leaving a channel),
that window will be removed entirely.

== /windows

Expand Down Expand Up @@ -142,4 +143,6 @@ Set window property.
Set window shortcut letter. If no letter is provided the next available
letter will automatically be assigned.

Available letters are configured in the `window-names` configuration setting.
Available letters are configured in the `window-names` config setting,
which defaults to the characters available from
the top letter and number rows on a QWERTY keyboard.

0 comments on commit 1ddcbba

Please sign in to comment.