-
Notifications
You must be signed in to change notification settings - Fork 44
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: add BibTeX format citation #1765
Conversation
Reviewer's Guide by SourceryThe PR adds BibTeX format citations for both the CovsirPhy library and the COVID-19 dataset in Japan. The changes are implemented by adding new sections in the respective README files with properly formatted BibTeX entries that include author information, title, year, URL, and access date placeholders. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Assessment against linked issues
Possibly linked issues
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 @lisphilar - I've reviewed your changes - here's some feedback:
Overall Comments:
- There's a syntax error in the URLs of both BibTeX entries - an unmatched parenthesis
)
that needs to be removed. - Both BibTeX entries use the same citation key
github_repo
. Consider using distinct keys (e.g.,covsirphy
andjapan_dataset
) to avoid conflicts when citing both sources.
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: 3 issues found
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Related issues
Close #1764.
What was changed
Add BibTeX format citations of CovsirPhy and COVID-19 dataset in Japan.
Summary by Sourcery
Documentation: