From bb86a13323e99386ad34d178ee839a66419b3ac8 Mon Sep 17 00:00:00 2001 From: Josh Price Date: Mon, 17 Oct 2022 11:36:37 +1100 Subject: [PATCH] docs: refactor diagram, fix doc typos and formatting (#419) --- lib/ash/api/{diagram => info}/diagram.ex | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) rename lib/ash/api/{diagram => info}/diagram.ex (94%) diff --git a/lib/ash/api/diagram/diagram.ex b/lib/ash/api/info/diagram.ex similarity index 94% rename from lib/ash/api/diagram/diagram.ex rename to lib/ash/api/info/diagram.ex index 49bd82bf..2cc2bd6f 100644 --- a/lib/ash/api/diagram/diagram.ex +++ b/lib/ash/api/info/diagram.ex @@ -6,8 +6,8 @@ defmodule Ash.Api.Info.Diagram do We can't easily model Ash relationships with Mermaid diagrams because they are unidirectional and could be asymmetric. - Mermaid assumes symmetrical, biredirectional relationships. - If we try to model all unidirectional realtionships as separate + Mermaid assumes symmetrical, bidirectional relationships. + If we try to model all unidirectional relationships as separate lines in the diagram it gets very hard to read very quickly. """ @@ -82,9 +82,11 @@ defmodule Ash.Api.Info.Diagram do Ash.Resource.Info.aggregates(resource) } else - {Ash.Resource.Info.public_attributes(resource), - Ash.Resource.Info.public_calculations(resource), - Ash.Resource.Info.public_aggregates(resource)} + { + Ash.Resource.Info.public_attributes(resource), + Ash.Resource.Info.public_calculations(resource), + Ash.Resource.Info.public_aggregates(resource) + } end contents =