-
-
Notifications
You must be signed in to change notification settings - Fork 128
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 inverted link tags #692
docs: fix inverted link tags #692
Conversation
Reviewer's Guide by SourceryThis PR fixes inverted Markdown link tags in the unit testing documentation, ensuring links render correctly. Flow diagram showing Markdown link syntax correctiongraph LR
A["(text)[url]"] -->|"Fixed to"| B["[text](url)"]
style A fill:#ffcccc
style B fill:#ccffcc
note["Markdown links require square brackets<br/>for text and parentheses for URL"]
note -.-> B
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey @pbratkowski - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
Ty! ❤️
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #692 +/- ##
=======================================
Coverage 89.05% 89.05%
=======================================
Files 42 42
Lines 3836 3836
=======================================
Hits 3416 3416
Misses 420 420 ☔ View full report in Codecov by Sentry. |
Description
The tag pairs
[ ]
and( )
are inverted (i.e.(text)[link]
, rather than[text](link)
), preventing the links from rendering correctly on the Unit testing page of the guide, as shown in the attached screenshot.This PR sets them in the correct order.
Types of Changes
Checklist
Summary by Sourcery
Documentation: