document dsl rules for advance queries
まだ誰も着手していません。
- 主要言語
- Clojure
- スター
- 192
- フォーク
- 95
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンク先のドキュメントページにある「Advanced Queries」セクションから始め、そこにある例を deps/db/src/logseq/db/rules.cljc の :between ルールと比較してください。対象となるルールの文書化された意味を明確にし、ルール定義と一致するように例を修正してください。ルールが文書化され、参照されているクエリが誤解を招くものではなくなれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- clojure
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100