idank / idank/explainshell

Mention word splitting and globbing

Open
#129 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
14.2k
Forks
851
PR merge metrics
No merged PRs in 30d

Description

screenshot

In this description it does not distinguish between the $ operator used bare and the $ operator in quotes. The bare $ operator should mention that it performs word splitting and globbing, which is almost always undesirable behaviour for a beginning scripter.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Use the linked screenshot to locate the description of the $ operator, then inspect how the bare and quoted forms are currently explained. Update the documentation so the bare form mentions word splitting and globbing while keeping the quoted form distinct; done means both behaviors are clearly differentiated.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.