chore(docs): specify syntax highlighting language for code blocks#51
chore(docs): specify syntax highlighting language for code blocks#51cnlangzi merged 3 commits intoyaitoo:mainfrom
Conversation
Reviewer's GuideThis PR improves the README.md by adding explicit language identifiers to code fences for syntax highlighting and tidies up formatting and whitespace for clearer documentation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- A few code blocks (e.g. the migration go:embed snippet) are still using generic
fences—consider labeling all fences (go, ```sql) for consistency. - The migration SQL example now uses ```sql, but the previous unannotated fences elsewhere could benefit from language tags as well to improve readability.
- The change to add a
>on the "All examples…" line looks like it might break list or blockquote formatting—please verify that it renders correctly in Markdown.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- A few code blocks (e.g. the migration go:embed snippet) are still using generic ``` fences—consider labeling all fences (```go, ```sql) for consistency.
- The migration SQL example now uses ```sql, but the previous unannotated fences elsewhere could benefit from language tags as well to improve readability.
- The change to add a `>` on the "All examples…" line looks like it might break list or blockquote formatting—please verify that it renders correctly in Markdown.
## Individual Comments
### Comment 1
<location> `README.md:515` </location>
<code_context>
-see more [examples](./migrate/migrator_test.go?L40)
+see more [examples](./migrate/migrator_test.go?L40)
if a table has been rotated, and migration should be started with `/* rotate: monthly=20240201-20240401*/` as first line. so the migration is applied automatically on the table and all it's rotated tables from 20240201 to 20240401.
-```
+```sql
</code_context>
<issue_to_address>
Typo: 'it's' should be 'its' (possessive form).
'It's' is a contraction for 'it is'; use 'its' for the possessive form here.
</issue_to_address>
<suggested_fix>
<<<<<<< SEARCH
if a table has been rotated, and migration should be started with `/* rotate: monthly=20240201-20240401*/` as first line. so the migration is applied automatically on the table and all it's rotated tables from 20240201 to 20240401.
=======
if a table has been rotated, and migration should be started with `/* rotate: monthly=20240201-20240401*/` as first line. so the migration is applied automatically on the table and all its rotated tables from 20240201 to 20240401.
>>>>>>> REPLACE
</suggested_fix>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
Here's the code health analysis summary for commits Analysis Summary
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #51 +/- ##
=======================================
Coverage 75.71% 75.71%
=======================================
Files 46 46
Lines 2368 2368
=======================================
Hits 1793 1793
Misses 456 456
Partials 119 119
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
cnlangzi
left a comment
cnlangzi
left a comment
There was a problem hiding this comment.
Well done. Thanks for your PR
|
@domust docs should not affect Lint check. It must be an other problem. I'm really appreciated if you can get some time left to check and fix it. thanks. |
|
@cnlangzi it was the default behavior of golangci-lint, it lints the entire project instead of only the parts that were changed. How would you like to proceed with the whole merging process? The 2 additional commits that addressed the issues don't follow the project's convention. Will those be squashed on merge or will I have to update the PR to contain only a single commit for it to be merged? |
|
|
@domust let's merge it first. It should run the old github action from |
|
@cnlangzi if |
2 participants
Hi,
I've been using this library for the last couple of days and it's great.
It was a bit hard to read documentation without syntax highlighting though, so I've decided to contribute. I've tried to follow the commit message format to the best of my ability.
Summary by Sourcery
Specify syntax highlighting languages for code blocks in README.md
Documentation: