Cite the literature: CITATION.cff, a bibliography, and citations in docstrings
Les mainteneurs répondent en général sous 3 jours
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- Active
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
🌀 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.
- Langage dominant
- Python
- Étoiles
- 142
- Forks
- 19
- Merge moyen
- 3 j 47 min
- PR mergées (30 j)
- 8
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de xqlsystems/xarray-sql
-
dependencies github_actions
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
xqlsystems/xarray-sql#295 ·
Les mainteneurs répondent en général sous 3 jours
-
A big-endian data variable registers, then every query fails: Byte-swapped arrays not supportedOuvertebug
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
xqlsystems/xarray-sql#288 ·
Les mainteneurs répondent en général sous 3 jours
-
documentation ml
Difficulté 1/5 1-3 heures Accessibilité débutants 85/100
xqlsystems/xarray-sql#268 ·
Les mainteneurs répondent en général sous 3 jours
-
enhancement ml
Difficulté 2/5 1-3 heures Accessibilité débutants 64/100
xqlsystems/xarray-sql#267 · 4 commentaires ·
Les mainteneurs répondent en général sous 3 jours
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 74/100
xqlsystems/xarray-sql#243 ·
Les mainteneurs répondent en général sous 3 jours
Toutes les issues de xqlsystems/xarray-sql
Issues similaires
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Textualize/textual#6753 · 1 commentaire ·
-
priority:low size:small
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
RonaldHensbergen/composable-data-stack#1177 ·
Les mainteneurs répondent en général sous 1 jour
-
Use registered media types for HDF5 and NetCDF, and stop claiming media_type must be IANA-registeredOuvertedocumentation metadata
Difficulté 2/5 1-3 heures Accessibilité débutants 87/100
Les mainteneurs répondent en général sous 1 jour
-
check-typing: ty 0.0.98+ fails on the renamed rule `unresolved-import` (now `import-not-found`)Peut-être pris @oberstet l’a pris aujourd’hui. Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 91/100
crossbario/cfxdb#145 ·