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

Introduce /redraw command #1931

Merged
merged 1 commit into from
Nov 14, 2023

Conversation

H3rnand3zzz
Copy link
Contributor

See commit message.

@H3rnand3zzz H3rnand3zzz force-pushed the feature/redraw-command branch from b1226c1 to 98475c4 Compare November 13, 2023 15:19
CMD_SYN(
"/redraw")
CMD_DESC(
"Redraw User Interface. Might be used in case if some other program interrupted and interface is \"broken\"." )
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure in case if is correct. I think the if can be canceled. Personally I probably would just use the first sentence.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also believe User and Interface should be lower case.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Redraw User Interface. Might be used in case if some other program interrupted and interface is \"broken\"." )
"Redraw user interface. Can be used when some other program interrupted profanity or wrote to the same terminal and the interface looks \"broken\"." )

I also would just use the first sentence, but that's because I'm lazy :)

Here we're writing the help text for our users, which also shows up in the man pages, and I like the idea to include the "why" some command exists.

Copy link
Member

@jubalh jubalh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just description. Rest looks ok.

@jubalh
Copy link
Member

jubalh commented Nov 14, 2023

I think some users use a keybinding for their terminal. But probably a command can be helpful.

Copy link
Member

@sjaeckel sjaeckel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can be merged after description is updated.

`/redraw` command allows resolve problem for usual users,
as well as developers.

Incredibly useful when debugging with something that
can trash out the output, like GDB.

Not to mention many asynchronous commands that can break the UI
at any point.
@H3rnand3zzz H3rnand3zzz force-pushed the feature/redraw-command branch from 98475c4 to a1ff88c Compare November 14, 2023 12:32
@H3rnand3zzz
Copy link
Contributor Author

updated

@jubalh jubalh merged commit 62e1de0 into profanity-im:master Nov 14, 2023
6 checks passed
@H3rnand3zzz H3rnand3zzz deleted the feature/redraw-command branch November 14, 2023 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants