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

Can we add hyperlink to the data types? #1023

Open
xie-zheng opened this issue Aug 25, 2023 · 3 comments
Open

Can we add hyperlink to the data types? #1023

xie-zheng opened this issue Aug 25, 2023 · 3 comments

Comments

@xie-zheng
Copy link

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:
  1. > sleep 1sec
  2. > 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.

@fdncred
Copy link
Collaborator

fdncred commented Aug 25, 2023

I think it would be a good add. However, I'm not sure we have links to all data types. Our docs probably aren't up to date.

@xie-zheng
Copy link
Author

xie-zheng commented Aug 25, 2023

@fdncred
I am thinking about if we can make this possible step by step,
like add docs to data types that dont have doc yet first,
then linked the type to the doc like the rustdoc did.

or we go straight to add hyperlink for exisiting docs first,
then we fix other that missing docs.

If we can come up with a plan, then we might be able to achieve it!

@fdncred
Copy link
Collaborator

fdncred commented Aug 25, 2023

sure, i'm fine with doing it step by step. you should feel free to look around to see if we have docs on datatypes and add them if they don't exist via PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants