Add minimal documentation to in ir in trustfall_core
#139
Conversation
ginger51011
changed the title
ir in trustfall_core
|
|
trustfall_core/src/ir/mod.rs
Outdated
| @@ -49,8 +54,12 @@ pub struct EdgeParameters( | |||
| #[serde(default, skip_serializing_if = "BTreeMap::is_empty")] pub BTreeMap<Arc<str>, FieldValue>, | |||
| ); | |||
|
|
|||
| /// IR of components of a query, containing information about the vertex ID | |||
There was a problem hiding this comment.
Do you think it's worth trying to stick to always saying Vid throughout the docs, even linking to it as needed? It's a core concept and will keep coming up all over the place in the IR, so I'm worried that mixing between vertex ID and Vid may be more confusing than just sticking to the unambiguous term that the reader has to learn.
There was a problem hiding this comment.
I think it might be worth linking it every time (so it's always easy to find the definition), but yes it should be the same. I'll replace them!
| @@ -26,17 +27,21 @@ lazy_static! { | |||
| pub(crate) static ref TYPENAME_META_FIELD_ARC: Arc<str> = Arc::from(TYPENAME_META_FIELD); | |||
| } | |||
|
|
|||
| /// Vertex ID | |||
| #[doc(alias("vertex", "node"))] | |||
| use async_graphql_value::{ConstValue, Number, Value}; | ||
| use chrono::{DateTime, Utc}; | ||
| use serde::{Deserialize, Serialize}; | ||
|
|
||
| /// Values of fields in GraphQL types. | ||
| /// | ||
| /// For version that is serialized as an untagged enum, see [TransparentValue]. |
Better IRQueryComponent docs Co-authored-by: Predrag Gruevski <[email protected]>
Co-authored-by: Predrag Gruevski <[email protected]>
|
Thank you for taking the time to review! |
| @@ -611,7 +611,7 @@ fn compute_fold<'query, DataToken: Clone + Debug + 'query>( | |||
| /// | |||
| /// A small subtlety is important here: it's possible that the tagged value is *local* to | |||
| /// the scope being filtered. In that case, the context *will not* yet have a token associated | |||
| /// with the vertex ID of the tag's ContextField. However, in such cases, the tagged value | |||
| /// with the [Vid] of the tag's ContextField. However, in such cases, the tagged value | |||
There was a problem hiding this comment.
Doesn't have to be in this PR, just wondering: can we link ContextField here too?
|
Thanks for all the awesome contributions, they are making a huge difference 🚀 |
Again from #136. These are just minimal docs, to help with understanding
trustfall_core/src/ir/