Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

LOSTANDFOUND.md: add missing URL, fix Markdown typo #21154

Merged
merged 1 commit into from
Jan 21, 2025

Conversation

crasbe
Copy link
Contributor

@crasbe crasbe commented Jan 21, 2025

Contribution description

In Pull Request #18562, the removal of MIPS support was documented and the headline had the right Commit ID, however the URL was not added to the link section below.

In Pull Request #21146, a : was added after the headline, leading to Doxygen not recognizing the link and therefore not applying it.
Unfortunately while this PR was open, I didn't see it in time, so now it has to be fixed afterwards.

I think both PRs are from @MrKevinWeiss, but I don't want to blame him. I fought for hours with the LOSTANDFOUND.md to find the bug described in #21106, so I know how easy it is to get Markdown angry :D

Testing procedure

The documentation should still build and now show the links (they are still broken because of #21106, BUT there should now be <a href=... in the headlines.

Issues/PRs references

Corrects the regressions introduced in #18562 and #21146.

@crasbe crasbe requested a review from jia200x as a code owner January 21, 2025 15:50
@github-actions github-actions bot added the Area: doc Area: Documentation label Jan 21, 2025
@miri64 miri64 added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) labels Jan 21, 2025
@riot-ci
Copy link

riot-ci commented Jan 21, 2025

Murdock results

✔️ PASSED

b140a94 LOSTANDFOUND.md: add missing URL, fix Markdown typo

Success Failures Total Runtime
1 0 1 01m:24s

Artifacts

Copy link
Member

@miri64 miri64 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK. Lesson learned: A reviewer should always, always, always check the documentation generated by Murdock (see e.g. #21154 (comment) for this PR) to see if the rendering is right (it does look how @crasbe describes it to be expected. It appears for #18562 this nice Murdock feature was either not in place yet or temporarily deactivated, so @maribu is not to blame here either.

@miri64 miri64 enabled auto-merge January 21, 2025 17:09
@miri64 miri64 added this pull request to the merge queue Jan 21, 2025
Merged via the queue into RIOT-OS:master with commit adecba2 Jan 21, 2025
29 checks passed
@crasbe crasbe deleted the pr/fix_LOSTANDFOUND branch January 21, 2025 17:44
@MrKevinWeiss
Copy link
Contributor

Thanks for fixing it!

@MrKevinWeiss
Copy link
Contributor

I suppose I should backport this as well 😬

@MrKevinWeiss MrKevinWeiss added the Process: needs backport Integration Process: The PR is required to be backported to a release or feature branch label Jan 21, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Process: needs backport Integration Process: The PR is required to be backported to a release or feature branch Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants