The links are not following the https://www.markdownguide.org/cheat-sheet/ format.
Visit README.md and see the links: https://git.drupalcode.org/project/search_api/-/raw/8.x-1.x/README.md
| Comment | File | Size | Author |
|---|---|---|---|
| #7 | Screenshot 2022-11-13 142207.jpg | 89.76 KB | Pracheth |
| #7 | Screenshot 2022-11-13 142230.jpg | 92.61 KB | Pracheth |
| #7 | Screenshot 2022-11-13 141530.jpg | 25.36 KB | Pracheth |
| #6 | 3265881-6--readme_changes.patch | 6.04 KB | drunken monkey |
Show commandsStart within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
changes
Comments
Comment #2
ressaComment #4
ressaHere is a Merge Request which updates the links. I think the failing test is an unrelated Composer issue?
Comment #5
ressaSo, I just realized that Reference Links is a Markdown option, but isn't it better to keep it simple, and use the
[link text](Url)format?Comment #6
drunken monkeyThanks for creating this issue!
However, as you already noted, there’s nothing wrong with the current formatting of the links, and I prefer them the way they are. I think it makes it much easier to read the source text. I do now see that Gitlab apparently doesn’t correctly parse our current syntax, though, so we should probably fix that. Hopefully just a matter of removing spaces and empty
[]syntax.Regarding the
’and similar characters: those are just encoding issues. Switch your editor/IDE to UTF-8 (as you should, anyways, according to Drupal guidelines) and they will be displayed correctly.Reviewing the README I furthermore noticed that we do not list the
search_api_random_sortfeature that the module defines (for over ten years now, in fact), so we should take the opportunity to add that as well.I also like your suggested formatting of the plugin directories as a table, thanks for that!
Revised patch attached, please review and tell me what you think.
Comment #7
Pracheth commentedHi @drunken monkey,
Reviewed you patch(3265881-6--readme_changes.patch), the patch applied cleanly and the changes suggested in #6 is reflected in README.md.
Changing status to Reviewed and Tested by Community.
Comment #8
ressaYou're welcome @drunken monkey! It does make the formatting of the lines less busy with reference links, so that's fine with me.
Personally, I am not a fan of the non-standard characters (’ vs. ' and “ vs. ") and just think it makes more sense to use the standard characters. But that's of course just my opinion, and you should feel free to keep them as they are :-)
I agree,
search_api_random_sortshould be added, great idea.I have updated the maintainer formatting, I see that a few modules use the format
Wilfrid Roze (eme) - https://www.drupal.org/u/eme.So all in it looks fine and ready. I have committed your patch from #6 in the MR, so it's available for preview.
Comment #10
drunken monkeyThanks for reviewing, @Pracheth!
Also thanks to ressa, for continuing to work on this. Good to see the new formatting actually gets displayed correctly on Gitlab.
I don’t think there is a standard for how to list maintainers, so I’m gonna leave this as-is. I don’t think displaying the URL has any added value there.
So, committed my patch from #6. Thanks again, everyone!
Comment #11
ressaGreat to see this land, thanks!
Comment #12
Pracheth commentedWelcome @ drunken monkey. Thanks!