Skip to content

README fix defaults comment #12727

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

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

README fix defaults comment #12727

wants to merge 1 commit into from

Conversation

JOJ0
Copy link

@JOJ0 JOJ0 commented Oct 5, 2024

The defaults stated in the plugin's README.md seem to be incorrect. According to the plugin's code all 3 options are enabled by default (when not zstyle lines are commented out):

zstyle -t ':omz:plugins:alias-finder' longer && longer=true
zstyle -t ':omz:plugins:alias-finder' exact && exact=true
zstyle -t ':omz:plugins:alias-finder' cheaper && cheaper=true

Standards checklist:

  • The PR title is descriptive.
  • The PR doesn't replicate another PR which is already open.
  • I have read the contribution guide and followed all the instructions.
  • The code follows the code style guide detailed in the wiki.
  • The code is mine or it's from somewhere with an MIT-compatible license.
  • The code is efficient, to the best of my ability, and does not waste computer resources.
  • The code is stable and I have tested it myself, to the best of my abilities.
  • If the code introduces new aliases, I provide a valid use case for all plugin users down below.

Changes:

  • Fixes wrongly stated default state of zstyle variables (inline comments)
  • Fixes a tiny grammar typo

Other comments:

...

@ohmyzsh ohmyzsh bot added Area: plugin Issue or PR related to a plugin Type: documentation Documentation issue or Pull Request labels Oct 5, 2024
@JOJ0 JOJ0 marked this pull request as draft October 5, 2024 06:03
@JOJ0 JOJ0 changed the title Typo and defaults fix README.md README fix defaults comment Oct 5, 2024
@mcornella
Copy link
Member

zstyle -t returns false by default, so the condition will evaluate to false and the settings will not be enabled:

zstyle -t ':omz:plugins:alias-finder' longer && longer=true
zstyle -t ':omz:plugins:alias-finder' exact && exact=true
zstyle -t ':omz:plugins:alias-finder' cheaper && cheaper=true

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: plugin Issue or PR related to a plugin Type: documentation Documentation issue or Pull Request
Projects
Status: Backlog
Development

Successfully merging this pull request may close these issues.

2 participants