question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

How do I link to a file?

See original GitHub issue

I have used some code from an external package which is not exported and I would like to create some link/see reference to it so others will know where this is coming from and if it is maybe exported in the future to remove it.

Is using @see the right way? I could not find anything about js/tsdoc and file urls. But @link in this case does not really get the file url correctly because of the at in angualr and asks for some hash.

Bildschirmfoto 2020-07-28 um 10 11 50 Bildschirmfoto 2020-07-28 um 10 11 45

Issue Analytics

  • State:open
  • Created 3 years ago
  • Reactions:8
  • Comments:8

github_iconTop GitHub Comments

3reactions
jonnytest1commented, May 13, 2022

ok i did a bit more testing :

you can

 /**
   * @see [text](./file.ts) 
   */

this link appears in the tooltip

however this one doesnt work in the editor in vscode 😅 so maybe adding both might be an option

i also dont know if this is a typescript or vscode thing so i cant say for certain wether this will work in other IDEs

2reactions
mctrafikcommented, Sep 20, 2022

How is this still an issue? Just tried it and none of the suggestions above work in Windows. 😦

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to create a link to a file or folder in Windows (2 ways)
Essentially, what you need to do is open File Explorer, navigate to the file, folder, or library you want to hyperlink, and right-click...
Read more >
How to create a link to File or Folder in Windows 11/10
To create a link to a file in Windows, you can go to the Properties menu and copy the Location first. Then, paste...
Read more >
Creating a Link to an Existing Local File
Highlight the text (or image) that you would like to turn into a link. · Click the Create Hyperlink icon (Figure) in the...
Read more >
Sharing files and folders with links - Sync
How do I link to a file or folder? · Sign in to the web panel. · Hover your mouse over any file...
Read more >
Adding a file or folder hyperlink - MindManager
To add a hyperlink to a file or folder: · Select a topic in Map View or Outline View, or, within the topic...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found