docs(citation): bring CITATION.cff current, and cite the publishing name - #123
Merged
Conversation
`version` read 0.1 while pyproject and the latest tag both read 0.17.0 -- sixteen minor versions stale, and stamped onto every Zenodo deposit this repo has produced. `date-released` was ten months behind. Both corrected against the repo's own facts. Adds `identifiers` for the C-series supplement: the concept DOI (10.5281/zenodo.22167995, always the latest version) and the version DOI (10.5281/zenodo.22167996, the ten counted packages), each labelled so a reader picks deliberately rather than by whichever appears first. **`authors` now reads Vettrivel**, which the author confirmed is the name they publish under, though Viswanathan is the legal surname. The reason is discovery rather than formality: a scholarly profile aggregates on the publishing name, so a supplement DOI minted under the legal name would sit outside the author's publication record -- the opposite of what a citable deposit is for. **A correction to advice given earlier in this work.** I twice called CITATION.cff the root cause of the C-series deposit being titled "Unit of Assurance (UoFA) Specification". It is not. That title is CORRECT for the repository, and Zenodo inheriting it is correct behaviour; retitling this file to name the data supplement would mistitle every future deposit in the other direction. The supplement's title is a per-record edit on the Zenodo record. **Still open, and the author's:** `preferred-citation` reads "(v0.1)" and points at uofa.net while the protocol adopted v0.2 today. Bumping it would assert a v0.2 report exists at that URL, which cannot be verified from this repository.
ORCID 0000-0002-1025-0244 on both author blocks. Verified against the public ORCID API before embedding: the record reads "Vishnu Vettrivel", matching the publishing name this file now uses, so the identifier and the spelling agree rather than one being asserted over the other. This is the field that actually resolves the name question. Viswanathan is the legal surname and Vettrivel is the publishing name; an ORCID binds a deposit to an identifier rather than a spelling, so it aggregates correctly whichever surname a given venue records. `preferred-citation` moves from v0.1 to **v0.2**, adopted today, with the year and month corrected to match (2026-08). Raised earlier as unverifiable from inside this repository -- whether a v0.2 report stands at uofa.net is the author's knowledge, and the author has ruled it does. Note the two author blocks sit at different indentation (top-level `authors` at two spaces, `preferred-citation.authors` at four). A single find-and-replace across both silently edits one and misses the other; this commit matched each block explicitly, which is why the first attempt asserted rather than wrote.
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.
Fixed
version0.10.17.0pyproject.toml, tagv0.17.0date-released2025-11-012026-08-29identifiersauthorsViswanathanVettrivelversion: 0.1was sixteen minor versions stale and has been stamped onto every Zenodo deposit this repo has produced.On the name
Viswanathanis the legal surname;Vettrivelis the name the author publishes under. The citation file takes the publishing name for discovery, not formality: a scholarly profile aggregates on the published name, so a supplement DOI minted under the legal name would sit outside the author's publication record — the opposite of what a citable deposit is for.An
orcid:field would make this durable in a way a name string cannot, binding the deposit to an identifier rather than a spelling. Not added; the author has one to supply or not.A correction to earlier advice in this work
I twice called
CITATION.cffthe root cause of the C-series deposit being titled "Unit of Assurance (UoFA) Specification". It is not. That title is correct for the repository, and Zenodo inheriting it is correct behaviour — retitling this file to name the data supplement would mistitle every future deposit in the other direction.The supplement's title is a per-record metadata edit on the Zenodo record.
Still open, and the author's
preferred-citationreads "(v0.1)" and points atuofa.net, while the protocol adopted v0.2 today. Bumping it would assert a v0.2 report exists at that URL, which cannot be verified from this repository.Verification
Parses as valid CFF, required keys present, 2 identifiers.
3421 passed, 14 skipped.