Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix broken links, fix #1613 #1686

Merged
merged 2 commits into from
Jan 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dfir_datalog/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use quote::{quote, ToTokens};
///
/// This uses a variant of Datalog that is similar to [Dedalus](https://www2.eecs.berkeley.edu/Pubs/TechRpts/2009/EECS-2009-173.pdf).
///
/// For examples, see [the datalog tests in the Hydroflow repo](https://github.com/hydro-project/hydro/blob/main/hydroflow/tests/datalog_frontend.rs).
/// For examples, see [the datalog tests in the Hydroflow repo](https://github.com/hydro-project/hydro/blob/main/dfir_rs/tests/datalog_frontend.rs).
// TODO(mingwei): rustdoc examples inline.
#[proc_macro]
pub fn datalog(item: proc_macro::TokenStream) -> proc_macro::TokenStream {
Expand Down
2 changes: 1 addition & 1 deletion dfir_lang/src/graph/ops/lattice_bimorphism.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use super::{
RANGE_0, RANGE_1,
};

/// An operator representing a [lattice bimorphism](https://hydro.run/docs/hydroflow/lattices_crate/lattice_math#lattice-bimorphism).
/// An operator representing a [lattice bimorphism](https://hydro.run/docs/dfir/lattices_crate/lattice_math#lattice-bimorphism).
///
/// > 2 input streams, of type `LhsItem` and `RhsItem`.
///
Expand Down
2 changes: 1 addition & 1 deletion dfir_lang/src/graph/ops/reduce_keyed.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use crate::diagnostic::{Diagnostic, Level};
/// > The output will have one tuple for each distinct `K`, with an accumulated (reduced) value of
/// > type `V`.
///
/// If you need the accumulated value to have a different type than the input, use [`fold_keyed`](#keyed_fold).
/// If you need the accumulated value to have a different type than the input, use [`fold_keyed`](#fold_keyed).
///
/// > Arguments: one Rust closures. The closure takes two arguments: an `&mut` 'accumulator', and
/// > an element. Accumulator should be updated based on the element.
Expand Down
1 change: 1 addition & 0 deletions dfir_macro/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,7 @@ fn main() {
const PREFIX: &str = "\
---
sidebar_position: 4
custom_edit_url: https://github.com/hydro-project/hydro/tree/main/dfir_lang/src/graph/ops
---

# DFIR Operators
Expand Down
4 changes: 2 additions & 2 deletions dfir_rs/src/util/monotonic.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/// A wrapper christening a closure as a [monotonic function](https://hydro.run/docs/hydroflow/lattices_crate/lattice_math#the-calm-theorem-and-monotonicity)
/// A wrapper christening a closure as a [monotonic function](https://hydro.run/docs/dfir/lattices_crate/lattice_math#the-calm-theorem-and-monotonicity)
#[repr(transparent)]
#[derive(Clone, Copy)]
pub struct MonotonicFn<F>(pub F);

/// A wrapper christening a closure as a [lattice morphism](https://hydro.run/docs/hydroflow/lattices_crate/lattice_math#lattice-morphism)
/// A wrapper christening a closure as a [lattice morphism](https://hydro.run/docs/dfir/lattices_crate/lattice_math#lattice-morphism)
#[repr(transparent)]
#[derive(Clone, Copy)]
pub struct Morphism<F>(pub F);
2 changes: 1 addition & 1 deletion docs/docs/dfir/architecture/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ here is the graph from the

<mermaid value={extractMermaid(exampleOutput)}></mermaid>

The [DFIR Architecture Design Doc](https://hydro-project.github.io/hydroflow/design_docs/2021-10_architecture_design_doc.html)
The [DFIR Architecture Design Doc](https://hydro-project.github.io/hydro/design_docs/2021-10_architecture_design_doc.html)
contains a more detailed explanation of this section. Note that some aspects of
the design doc are not implemented (e.g. early yielding) or may become out of
date as time passes.
Expand Down
Loading