-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
docs: fix broken links in overview.md
#3440
Conversation
Fixed 2 broken links
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the contribution.
Within this doc, there are two other places where the links are broken. Do you mind fixing them, too?
The other two are:
- tensorboard/backend/application.py
- DEVELOPMENT.md
docs/r1/overview.md
Outdated
@@ -311,15 +311,15 @@ method. | |||
|
|||
### Can I customize which lines appear in a plot? | |||
|
|||
Using the [custom scalars plugin](tensorboard/plugins/custom_scalar), you can | |||
Using the [custom scalars plugin](https://github.com/tensorflow/tensorboard/tree/master/tensorboard/plugins/custom_scalar), you can |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you use a relative path? i.e., ../../../tensorboard/plugins/custom_scalar
. Here and below
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure! I'll work on fixing the other two broken links you pointed out too!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! For context, the reason that we like relative links is that
they enable editors to cross-link. For instance, in Vim, I can just
press gf
(go-file) with my cursor on the relative link and it’ll open
in my editor.
Fixed two additional broken links. Changed previous link fixes to have relative paths.
removed superfluous white space
Converted all 4 broken links to working relative links
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for quick back and forth! 🙇
Fixed 2 broken links that were pointed out in tensorflow#2814. Fixes tensorflow#2814.
Fixed 2 broken links that were pointed out in #2814.
Fixes #2814.