docs: ensure docs are well-linked, fed and washed

This commit is contained in:
multisn8 2024-01-18 22:24:03 +01:00
parent e3df02b608
commit ce1d1e85a0
Signed by: multisamplednight
GPG key ID: 6D525AA147CBDAE2
2 changed files with 7 additions and 7 deletions

View file

@ -4,17 +4,14 @@ use serde::{Deserialize, Serialize};
pub mod id; pub mod id;
pub mod instruction; pub mod instruction;
pub mod semi_human;
// feel free to make this public if there's sufficient reason to do so
// otherwise, go use the GraphIr in the module this is written in directly instead!!
mod semi_human;
pub type Map<K, V> = ahash::AHashMap<K, V>; pub type Map<K, V> = ahash::AHashMap<K, V>;
pub type Set<V> = ahash::AHashSet<V>; pub type Set<V> = ahash::AHashSet<V>;
/// Gives you a super well typed graph IR for a given human-readable repr. /// Gives you a super well typed graph IR for a given human-readable repr.
/// ///
/// Look at [`SemiHumanGraphIr`] and the test files in the repo at `testfiles/` /// Look at [`semi_human::GraphIr`] and the test files in the repo at `testfiles/`
/// to see what the RON should look like. /// to see what the RON should look like.
/// No, we don't want you to write out [`GraphIr`] in full by hand. /// No, we don't want you to write out [`GraphIr`] in full by hand.
/// That's something for the machines to do. /// That's something for the machines to do.
@ -31,8 +28,7 @@ pub fn from_ron(source: &str) -> ron::error::SpannedResult<GraphIr> {
/// ///
/// Pipelines may not be fully linear. They may branch out and recombine later on. /// Pipelines may not be fully linear. They may branch out and recombine later on.
/// As such, the representation for them which is currently used is a /// As such, the representation for them which is currently used is a
/// [**D**irected **A**cyclic **G**raph](https://en.wikipedia.org/wiki/Directed_acyclic_graph) /// [**D**irected **A**cyclic **G**raph](https://en.wikipedia.org/wiki/Directed_acyclic_graph).
/// .
/// ///
/// For those who are already familiar with graphs, a DAG is one, except that: /// For those who are already familiar with graphs, a DAG is one, except that:
/// ///

View file

@ -2,6 +2,10 @@
//! //!
//! Sacrifices type expressivity for the sake of typability in [RON] files. //! Sacrifices type expressivity for the sake of typability in [RON] files.
//! //!
//! **If you want to construct a graph IR programmatically,
//! use [`crate::GraphIr`] directly instead,
//! as it gives you more control to specify where your instructions came from.**
//!
//! [RON]: https://docs.rs/ron/latest/ron/ //! [RON]: https://docs.rs/ron/latest/ron/
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};