-
Notifications
You must be signed in to change notification settings - Fork 12
Documentation clean up #107
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
base: main
Are you sure you want to change the base?
Conversation
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.
Pull Request Overview
This PR performs documentation cleanup by fixing incorrect service descriptions and removing completion status indicators from the README. The main purpose is to correct misleading comments that referred to "issue related" methods when they should reference the actual service type (project, invoice, expense).
- Corrected service documentation comments to accurately reflect their purpose
- Simplified README by removing completion status legend and checkboxes
- Added proper error handling for URL parsing in the API client
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| harvest/project.go | Fixed service comment to reference "project related" instead of "issue related" |
| harvest/invoice.go | Fixed service comment to reference "invoice related" instead of "issue related" |
| harvest/expense.go | Fixed service comment to reference "expense related" instead of "issue related" |
| harvest/harvest.go | Added error handling for URL parsing operation |
| README.md | Removed completion status indicators and legend for cleaner documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| baseURL, _ := url.Parse(DefaultBaseURL) | ||
| baseURL, err := url.Parse(DefaultBaseURL) | ||
| if err != nil { | ||
| logrus.Error(err) |
Copilot
AI
Oct 11, 2025
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.
The error handling only logs the error but continues execution with a potentially nil baseURL. Consider either panicking for this critical error or providing a fallback URL.
| logrus.Error(err) | |
| panic(fmt.Sprintf("failed to parse DefaultBaseURL: %v", err)) |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #107 +/- ##
==========================================
- Coverage 76.00% 75.84% -0.17%
==========================================
Files 24 24
Lines 1542 1544 +2
==========================================
- Hits 1172 1171 -1
- Misses 251 253 +2
- Partials 119 120 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
No description provided.