Cite the literature: CITATION.cff, a bibliography, and citations in docstrings

Offen
  • Stimmt etwas nicht?
#296 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 3 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
python
Bereich
documentation

Rechercherichtung

Start with the root of the repo for a new CITATION.cff, then with AGENTS.md for the rule about introducing references before relying on them. The docs build (zensical, CI) decides which bibliography plugin fits, so check that config before choosing one. Done means CITATION.cff exists and parses, a bibliography file such as docs/references.bib holds the cited papers, and one docstring cites an entry that the docs build renders in CI.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation

🌀 Claude: xarray-sql builds on published work: FlashAttention, the Nadaraya–Watson estimator, and DeepMind's GraphCast in the ML demos, along with the database literature behind its query plans. Readers, and agents working on the code, would find it easier to follow and extend that work if the project cited it in one place, and could be cited itself.

Proposal:

  1. A CITATION.cff at the root, so GitHub shows "Cite this repository" and tools can read it.
  2. One bibliography (for example docs/references.bib) of the papers the code and docs rely on.
  3. Citations in docstrings and docs pages, resolved against that file. The docs are built with zensical, which is compatible with MkDocs, so a MkDocs bibliography plugin may work where a Sphinx one wouldn't. Whatever the choice, the docs build needs to be checked with CI's zensical.

The rule in AGENTS.md to introduce every reference before relying on it would then point to the bibliography.

Raised in review of #269.

Vorherrschende Sprache
Python
Sterne
142
Forks
19
Ø Merge
3 T. 47 Min.
Gemergte PRs (30 T.)
8

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus xqlsystems/xarray-sql

Alle Issues in xqlsystems/xarray-sql

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.