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 a note to section 10.1 of tutor #5309

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

x448
Copy link

@x448 x448 commented Dec 26, 2022

Add a note to the tutor in section 10.1 to prevent new users from thinking Helix is buggy or that the user is doing something wrong.

 NOTE: If typing ) or ( appears to do nothing, try using a 
 different color theme. These themes work well here:
 - dark_plus
 - emacs

Add a note to the tutor in section 10.1 to
prevent new users from thinking Helix is buggy
or that the user is doing something wrong.

NOTE: If typing ) or ( appears to do nothing, try using a theme
 that uses different colors for primary selection and cursor.
 These themes work well here:
 - dark_plus
 - emacs
@goyalyashpal
Copy link
Contributor

just tested on hx v22.05, and I'd say that this is a bug indeed with the default theme.

goyalyashpal added a commit to goyalyashpal/helix that referenced this pull request Dec 27, 2022
goyalyashpal added a commit to goyalyashpal/helix that referenced this pull request Dec 27, 2022
@goyalyashpal
Copy link
Contributor

This pr is like a patch for the bahaviour mentioned below:

Just to add to this: in section 10.1 of the hx --tutor, the features of cycling and removing selections are demonstrated. Since the default theme does not have a way to distinguish the primary selection, it appears that ( and ) don't do anything (especially to someone new to helix). Basically, it gives the impression that something is broken.

Originally posted by @taranlu-houzz in #3842 (comment)

@x448
Copy link
Author

x448 commented Dec 27, 2022

I think this note will be useful even if all the current themes are fixed because some future themes might have similar problems.

@goyalyashpal
Copy link
Contributor

goyalyashpal commented Dec 28, 2022

I think this note will be useful even if all the current themes are fixed because some future themes might have similar problems.

aahw, nice. fair point. i was thinking about its future use, but I wasn't able to see how it will work together, what will be the story behind.

say a user installs helix, and changes the theme in due course, but then after some time uses the helix tutor.

so, for those cases too, i'd like to point users to default theme. 'cz :

  • hey, the default theme should work out of the box for all the crucial things.
  • and we shouldn't refer to different themes on a per-case basis.

but ofcourse, that requires fixing the default theme first. that's what that other pr is for

Comment on lines +1010 to +1013
NOTE: If typing ) or ( appears to do nothing, try using a
different color theme. These themes work well here:
- dark_plus
- emacs
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
NOTE: If typing ) or ( appears to do nothing, try using a
different color theme. These themes work well here:
- dark_plus
- emacs
NOTE: If typing ) or ( appears to do nothing, try using the
default color theme.

Copy link
Contributor

Choose a reason for hiding this comment

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

ofcourse this will come after the default theme is fixed...

Copy link
Author

Choose a reason for hiding this comment

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

aahw, nice. fair point. i was thinking about its future use, but I wasn't able to see how it will work together, what will be the story behind.

say a user installs helix, and changes the theme in due course, but then after some time uses the helix tutor.

so, for those cases too, i'd like to point users to default theme. 'cz :

hey, the default theme should work out of the box for all the crucial things.
and we shouldn't refer to different themes on a per-case basis.

but ofcourse, that requires fixing the default theme first. that's what that other pr is for

ofcourse this will come after the default theme is fixed...

That's an interesting approach. I'm not sure it has quantifiable advantages because this PR

  • resolves a current problem without depending on a future PR fixing any theme
  • mitigates a future problem if the user chooses a buggy theme we don't know about
  • doesn't prevent default theme from being suggested once it is fixed (the PR fixing the default theme can include a commit to suggest using it inside the tutorial)

Why not merge this PR as-is first, then once the default theme is fixed, open a new PR to include it as a recommended workaround? This way would be less fragile because it doesn't introduce external dependencies.

If the next release doesn't include a fix for the default theme (or other problematic themes), then this PR would still be able to help new users and reviewers trying Helix tutorial.

Copy link
Contributor

@goyalyashpal goyalyashpal Dec 28, 2022

Choose a reason for hiding this comment

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

Why not merge this PR as-is first, then once the default theme is fixed, open a new PR to include it as a recommended workaround?

i don't have any concern with the order of it, the suggestion i gave is for how it should end eventually in my views.

To rephrase, i don't have any problem with what you said.

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.

3 participants