docs: use the paper's own abstract in CITATION.cff - #7
Merged
Conversation
The abstract added in #5 was a paraphrase written from the README, not the abstract of the preprint. Replace it with the published text, so anything that surfaces this file (GitHub's "Cite this repository", Zenodo, citation managers) shows what the paper actually says. The software-specific licensing and research-use note is kept as a short trailing note. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
abstractfield added in #5 was a paraphrase I wrote from the README, not the preprint's abstract. This replaces it with the published text.It matters because
CITATION.cffis what GitHub's Cite this repository box, Zenodo and citation managers read — a paraphrase there quietly becomes the project's description wherever the file is consumed.The software-specific note (PolyForm Noncommercial for code, CC-BY-NC-SA-4.0 for weights, research use only) is kept as a short trailing sentence, since the paper abstract does not cover licensing.
Verified:
CITATION.cffstill validates against cff-version 1.2.0 (cffconvert), and the abstract round-trips through the YAML folded scalar verbatim.🤖 Generated with Claude Code