Cite the literature: CITATION.cff, a bibliography, and citations in docstrings
Mantenedores costumam responder em até 3 dias
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Ativa
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
🌀 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.
- Linguagem predominante
- Python
- Estrelas
- 142
- Forks
- 19
- Merge médio
- 3d 47min
- PRs com merge (30d)
- 8
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de xqlsystems/xarray-sql
-
dependencies github_actions
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
xqlsystems/xarray-sql#295 ·
Mantenedores costumam responder em até 3 dias
-
A big-endian data variable registers, then every query fails: Byte-swapped arrays not supportedAbertabug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
xqlsystems/xarray-sql#288 ·
Mantenedores costumam responder em até 3 dias
-
documentation ml
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 85/100
xqlsystems/xarray-sql#268 ·
Mantenedores costumam responder em até 3 dias
-
enhancement ml
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
xqlsystems/xarray-sql#267 · 4 comentários ·
Mantenedores costumam responder em até 3 dias
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 74/100
xqlsystems/xarray-sql#243 ·
Mantenedores costumam responder em até 3 dias
Todas as issues de xqlsystems/xarray-sql
Issues semelhantes
-
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 88/100
aws-samples/sample-per-model-bedrock#782 ·
Mantenedores costumam responder em até 1 dia
-
Google text documents are base64-encoded twiceTalvez já em andamento @feiiiiii5 assumiu hoje. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
Mantenedores costumam responder em até 1 dia
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
coveragepy/coveragepy#2364 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 72/100