Cite the literature: CITATION.cff, a bibliography, and citations in docstrings
I maintainer di solito rispondono entro 3 giorni
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
🌀 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:
- A
CITATION.cffat the root, so GitHub shows "Cite this repository" and tools can read it. - One bibliography (for example
docs/references.bib) of the papers the code and docs rely on. - 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.
- Lingua principale
- Python
- Stelle
- 142
- Fork
- 19
- Merge medio
- 3g 47m
- PR unite (30g)
- 8
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di xqlsystems/xarray-sql
-
dependencies github_actions
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
xqlsystems/xarray-sql#295 ·
I maintainer di solito rispondono entro 3 giorni
-
A big-endian data variable registers, then every query fails: Byte-swapped arrays not supportedApertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
xqlsystems/xarray-sql#288 ·
I maintainer di solito rispondono entro 3 giorni
-
documentation ml
Difficoltà 1/5 1-3 ore Idoneità per principianti 85/100
xqlsystems/xarray-sql#268 ·
I maintainer di solito rispondono entro 3 giorni
-
enhancement ml
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
xqlsystems/xarray-sql#267 · 4 commenti ·
I maintainer di solito rispondono entro 3 giorni
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 74/100
xqlsystems/xarray-sql#243 ·
I maintainer di solito rispondono entro 3 giorni
Tutte le issue di xqlsystems/xarray-sql
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
SpikeInterface/spikeinterface#4924 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
aws-samples/sample-per-model-bedrock#782 ·
I maintainer di solito rispondono entro 1 giorno
-
bug javascript
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
No-op PreToolUse:Bash hook (bash_hook.py) still registered synchronously; adds latency and can time out at 10 sForse già presa @alexgr-agent l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
alexgreensh/token-optimizer#313 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100