document dsl rules for advance queries
Personne n'a encore pris cette issue.
- Langage dominant
- Clojure
- Étoiles
- 192
- Forks
- 95
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
I was trying to understand what's the actual meaning of `between`, but I can't find the documentation. It seems to be the task's journal date, but these queries made me think it's the referenced journal date: (Tasks referencing due dates ...)
https://github.com/logseq/docs/blob/cdbec0f9025507994559e5fb8aa607eae08006e1/pages/Advanced%20Queries.md#L177-L204
Then I found the definition here https://github.com/logseq/logseq/blob/master/deps/db/src/logseq/db/rules.cljc
```clojure
:between
'[(between ?b ?start ?end)
[?b :block/page ?p]
[?p :block/journal? true]
[?p :block/journal-day ?d]
[(>= ?d ?start)]
[(<= ?d ?end)]]
```
So it's indeed the task's journal date and the queries above are wrongly explained. I think it might be better to add documentation for these rules, and fixup the examples.
Guide de contribution
Ouvrir 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.
Piste de recherche
Commencez par la section « Advanced Queries » de la page de documentation liée et comparez ses exemples avec la règle :between dans deps/db/src/logseq/db/rules.cljc. Clarifiez la signification documentée des règles concernées et corrigez les exemples afin qu’ils correspondent aux définitions des règles. Le travail est terminé lorsque les règles sont documentées et que les requêtes référencées ne sont plus trompeuses.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- clojure
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 42/100