Skip to content

fix: standardize BibTeX citation to match main repo#14

Merged
paxcalpt merged 1 commit into
mainfrom
fix/standardize-citation
Mar 25, 2026
Merged

fix: standardize BibTeX citation to match main repo#14
paxcalpt merged 1 commit into
mainfrom
fix/standardize-citation

Conversation

@paxcalpt
Copy link
Copy Markdown
Contributor

Summary

Sync the BibTeX citation in README.md with the canonical citation from the main rxiv-maker repository:

  • Standardise citation key format (saraiva_2025_rxivmaker)
  • Fix title capitalisation to match arXiv entry
  • Remove extra primaryClass field not present in canonical version

Test plan

  • Citation block renders correctly on GitHub

🤖 Generated with Claude Code

Sync citation key, title capitalization, and formatting with the
canonical citation from the main rxiv-maker repository.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 25, 2026 08:34
@claude
Copy link
Copy Markdown

claude Bot commented Mar 25, 2026

PR Review: fix: standardize BibTeX citation to match main repo

This is a clean, documentation-only change. Here is my feedback:

Summary

The change syncs the BibTeX citation with the canonical upstream version. The diff is minimal and well-scoped.

Positive Observations

  • Cleaner citation key: saraiva_2025_rxivmaker is much more readable than saraiva2025rxivmakerautomatedtemplateengine and follows a common BibTeX convention (author_year_shortid).
  • LaTeX encoding for special characters: Switching from a raw UTF-8 character to the LaTeX-escaped form is a good improvement for BibTeX compatibility — raw UTF-8 can cause parsing errors in some BibTeX processors.
  • Reduced indentation: Moving from 6-space to 2-space indentation improves readability of the BibTeX block.

Minor Observations

  1. Title capitalization and missing braces: The title uses sentence case, which matches the arXiv canonical entry. However, neither version protects the product name with braces (e.g., {Rxiv-Maker}). In some bibliography styles, BibTeX may lowercase the entire title, potentially turning Rxiv-Maker into rxiv-maker. Since syncing with the canonical citation is the stated goal, this is acceptable as-is — but worth noting for users who copy this citation into their own work.

  2. Removed primaryClass: Removing primaryClass={cs.DL} is fine since it is optional. It is a useful field for arXiv preprints as it tells readers the subject category at a glance, but removing it to match the canonical version is reasonable.

  3. Test plan checkbox: The test plan item is unchecked. Since this is a Markdown code block it will render correctly regardless, but worth ticking off before merging.

Verdict

Approved with minor notes. This is a low-risk, well-motivated documentation fix. The main item to be aware of is the missing brace protection around Rxiv-Maker in the title field, but since this mirrors the canonical upstream citation it is not a blocker here.

Copy link
Copy Markdown

Copilot AI left a 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 updates the README’s BibTeX citation block to match the canonical citation format used in the main rxiv-maker repository, keeping this extension’s documentation aligned with the upstream project.

Changes:

  • Standardized the BibTeX citation key to saraiva_2025_rxivmaker
  • Updated the title capitalization to sentence case to match the arXiv entry
  • Removed the primaryClass field to mirror the canonical citation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@paxcalpt paxcalpt merged commit 6f925c2 into main Mar 25, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants