nushell / nushell/nushell.github.io
Can we add hyperlink to the data types?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 15
Description
As an example, I am reading the doc for the sleep command right now.
aka. https://www.nushell.sh/commands/docs/sleep.html
The signature says :
> sleep (duration) ...rest
and parameters are:
- duration: time to sleep
- ...rest: additional time
with example:
- > sleep 1sec
- > sleep 1sec 1sec 1sec
I tried to do sleep 1hour and that doesn't work, then I realize that 'duration' might be
some kind of datatypes of nu, so why not leave a hyperlink to the datatype in the docs?
I think this would improve the readability so much if we can link all datatypes to their definition.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the sleep command documentation at the linked page and identify how its parameter types are rendered. Check the datatype definitions and existing documentation links, then link datatype names consistently and verify that the sleep examples and generated command pages display the intended destinations.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100