Skip to content
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

Merged
merged 3 commits into from
Oct 28, 2024
Merged

docs: add BibTeX format citation #1765

merged 3 commits into from
Oct 28, 2024

Conversation

lisphilar
Copy link
Owner

@lisphilar lisphilar commented Oct 28, 2024

Related issues

Close #1764.

What was changed

Add BibTeX format citations of CovsirPhy and COVID-19 dataset in Japan.

Summary by Sourcery

Documentation:

  • Add BibTeX format citations for CovsirPhy and the COVID-19 dataset in Japan to the documentation.

@lisphilar lisphilar added the documentation Improvements or additions to documentation label Oct 28, 2024
@lisphilar lisphilar added this to the Release 3.1.3 milestone Oct 28, 2024
Copy link
Contributor

sourcery-ai bot commented Oct 28, 2024

Reviewer's Guide by Sourcery

The 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

Change Details Files
Added BibTeX citation format for the main CovsirPhy library
  • Added a new BibTeX entry with Hirokazu Takaya and CovsirPhy Development Team as authors
  • Included version number placeholder in the title
  • Added URL and access date placeholder in the note field
README.md
Added BibTeX citation format for the COVID-19 dataset in Japan
  • Added a new BibTeX entry with Hirokazu Takaya as author
  • Included dataset-specific title and URL
  • Added access date placeholder in the note field
data/README.md

Assessment against linked issues

Issue Objective Addressed Explanation
#1764 Add BibTeX citation format to the documentation for referencing the project in academic publications

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a 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 and japan_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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

README.md Outdated Show resolved Hide resolved
data/README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@lisphilar lisphilar merged commit c71ef36 into main Oct 28, 2024
12 checks passed
@delete-merged-branch delete-merged-branch bot deleted the issue1764 branch October 28, 2024 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] BibTex Format Citation Request
1 participant