document dsl rules for advance queries
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Clojure
- Sterne
- 192
- Forks
- 95
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Abschnitt „Advanced Queries“ auf der verlinkten Dokumentationsseite und vergleiche dessen Beispiele mit der Regel :between in deps/db/src/logseq/db/rules.cljc. Kläre die dokumentierte Bedeutung der betroffenen Regeln und korrigiere die Beispiele, sodass sie den Regeldefinitionen entsprechen. Die Aufgabe ist abgeschlossen, wenn die Regeln dokumentiert sind und die referenzierten Abfragen nicht mehr irreführend sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- clojure
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100