nushell / nushell/nushell.github.io

Documentation on type path doesn't match behaviour

Open
#2,155 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
258
Forks
561
Avg merge
3h 20m
Merged PRs (30d)
15

Description

String won't be expanded into a fully pathname when passed as an arguments with type of path

Document

Doc's here Nushell Type Path

def show_difference [
 p: path
 s: string
] {
 print $"The path is expanded: ($p)"
 print $"The string is not: ($s)"
}

# Results
cd ~/testing
show_difference . .
# => The path is expanded: /home/username/testing
# => The string is not: .

Actually

show_difference . .
# => The path is expanded: .
# => The string is not: .

nu --version
# => 0.112.2

You wouldn't be surprised. Code changes fast around here. Just a reminder
I like nushell, thanks for all works of yours

Contributor guide

Open the contributing guide

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

Start with the linked Nushell Type Path documentation and compare its example with the behavior reported for Nushell 0.112.2. Verify the current behavior before editing; done means the documentation accurately describes how path and string arguments are handled.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.