return-youtube-dislike icon indicating copy to clipboard operation
return-youtube-dislike copied to clipboard

Published 20 hours ago • verified publisher icon Anarios

Shorter/relative paths in Markdown files

Open Sky-NiniKo opened this issue 2 years ago • 9 comments

I think it makes more sense to use a relative path:

+ It shorter. (me) + It allows to refer to the corresponding file in a fork and not to the original file. (me) + Relative paths will function even if I move a directory tree into another (@​sy-b https://github.com/Anarios/return-youtube-dislike/pull/627#issuecomment-1140177384)

- If you download only part of the files to your local machine: the links are broken. (@sy-b https://github.com/Anarios/return-youtube-dislike/pull/627#issuecomment-1139306332) - More ambiguity and can lead to confusion (@cyrildtm https://github.com/Anarios/return-youtube-dislike/pull/627#issuecomment-1139806538) - Complete path can be understood at a glance (@​sy-b https://github.com/Anarios/return-youtube-dislike/pull/627#issuecomment-1140177384)

A vote ?

I don't know who has the last word on controversial PRs but I propose to vote either directly in this issue by reacting to this message with a like or a dislike or to open a poll.

Sky-NiniKo avatar May 27 '22 01:05 Sky-NiniKo

Let's say README.md is on my local machine and I want to read FAQ.md. If I encounter relative path(s), I'll definitely have to manually hunt for the file online. Of course, the relative paths make more sense when I have the whole repo but its a bit troublesome when I don't or I have an outdated one. This is the only downside I know. For rest of the cases, its good. For this particular case its 👍.

sy-b avatar May 27 '22 05:05 sy-b

I think absolute paths are clearer with the message you want to send. No ambiguity or confusion.

cyrildtm avatar May 27 '22 17:05 cyrildtm

I think absolute paths are clearer with the message you want to send. No ambiguity or confusion.

In your opinion, everything should be converted to absolute paths or exceptions should be made in certain cases such as perhaps links to translations. Because I can make a PR to do the opposite of this one. 😏

Sky-NiniKo avatar May 27 '22 20:05 Sky-NiniKo

I don't know who has the last word on controversial PRs

@‎anarios

sy-b avatar May 28 '22 05:05 sy-b

Some more advantages:

  • Relative Paths
    • Relative paths will function even if I move a directory tree into another
  • Absolute Paths
    • Complete path can be understood at a glance & as @cyrldtm mentioned - "No ambiguity or confusion"

sy-b avatar May 28 '22 05:05 sy-b

Actually I changed my mind. I just read your commits. Why would someone cite their own repo in full. For developers who's really downloading the source code, they should be smart enough to locate any missing files. The relative paths are clear enough. I wouldn't be confused by the relative path.

ps. it's amazing /something worked.

cyrildtm avatar May 28 '22 05:05 cyrildtm

For this particular case, it wouldn't a problem if we used relative path for README.md only. But I don't have a strong opinion yet.

sy-b avatar May 28 '22 05:05 sy-b

In some cases ../something can be dangerous.

~~I usually prefer to use /something.~~ The ../ in ../something refers the parent folder of the current the folder. And during directory shuffling, this can be a headache. Use ../ with caution.

sy-b avatar May 28 '22 05:05 sy-b

Use ../ with caution.

I will change if necessary but currently I do not even know if the PR will be merge. I'm waiting for standards.

Sky-NiniKo avatar May 28 '22 05:05 Sky-NiniKo