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

Add some vertical characters to the editor.indent-guides documentation #4163

Merged
merged 2 commits into from Oct 10, 2022
Merged

Conversation

ghost
Copy link

@ghost ghost commented Oct 9, 2022

This PR updates the default indent-guide character from a vertically aligned pipe (|) to a left aligned pipe ().

This makes a big difference visually as the indent guides are now aligned precisely to the indent level instead of starting half a character later.

  • Before

before

  • After

after

@archseer
Copy link
Member

archseer commented Oct 9, 2022

Can you show a screenshot of the two?

@ghost
Copy link
Author

ghost commented Oct 9, 2022

Can you show a screenshot of the two?

Hello @archseer! Thanks for taking a look. I've added screenshots to the top comment. Was struggling to capture them earlier (nvidia issues).

@the-mikedavis
Copy link
Member

I prefer the center-aligned (current) character

@dead10ck
Copy link
Member

dead10ck commented Oct 9, 2022

Yeah this seems like a preference thing that can be handled by the current config.

@ghost
Copy link
Author

ghost commented Oct 10, 2022

Yeah this seems like a preference thing that can be handled by the current config.

I agree, but this looks like a more reasonable default, at least to me. Setting the center aligned pipe is easier as it's available on the keyboard. Switching to the left aligned one requires a user to search for the particular Unicode character and then copy and paste it into their config.

That said, I'm fine with closing this as I've already updated my config :D

@poliorcetics
Copy link
Contributor

Switching to the left aligned one requires a user to search for the particular Unicode character and then copy and paste it into their config.

We could add a few variants to the documentation, that way people will discover alternatives at the same time they discover the option, and keep the | (vertical pipe) by default since that's a widely-supported character

@ghost
Copy link
Author

ghost commented Oct 10, 2022

We could add a few variants to the documentation

This sounds like a good idea. Makes it easy to switch and helps discoverability as well. I've updated the PR to add some characters to the documentation instead of changing the default. The more supported character is a good default.

@ghost ghost changed the title Use a left-aligned char for indent-guide Add some vertical characters to the indent-guides documentation Oct 10, 2022
@ghost ghost changed the title Add some vertical characters to the indent-guides documentation Add some vertical characters to the editor.indent-guides documentation Oct 10, 2022
Co-authored-by: Michael Davis <mcarsondavis@gmail.com>
@kirawi kirawi added A-documentation Area: Documentation improvements S-waiting-on-review Status: Awaiting review from a maintainer. labels Oct 10, 2022
@the-mikedavis the-mikedavis merged commit a079f2c into helix-editor:master Oct 10, 2022
@the-mikedavis
Copy link
Member

Thanks!

@ghost
Copy link
Author

ghost commented Oct 10, 2022

Thank you, everyone! First commit to helix 🥳

@ghost ghost deleted the indent-guide-default-char branch October 11, 2022 11:34
pathwave pushed a commit to pathwave/helix that referenced this pull request Nov 6, 2022
herkhinah pushed a commit to herkhinah/helix that referenced this pull request Dec 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation improvements S-waiting-on-review Status: Awaiting review from a maintainer.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants