From 80e5e46bd940f2b2ffcd53a64b7c20052e6bab86 Mon Sep 17 00:00:00 2001 From: waalge Date: Mon, 13 Jan 2025 10:32:33 +0000 Subject: [PATCH] Its important that users include trailing slash This is not clear enough in the docs. --- docs/developer-manual/consume.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/developer-manual/consume.md b/docs/developer-manual/consume.md index 94dc8191..a1657adf 100644 --- a/docs/developer-manual/consume.md +++ b/docs/developer-manual/consume.md @@ -170,7 +170,7 @@ Integrators should establish the expected feed ID from Orcfax documentation on the feed definition. The feed ID is a human readable label and decomposes as: ```sample -/ +// ``` Warning: Orcfax reserves the possibility to use a `versioned_feed_id` as the @@ -181,7 +181,9 @@ value in the statement. A versioned feed ID has the following form: ``` For this reason integrators must check that the `feed_id` value begins with the -expected bytes, rather than assume that there is equality. +expected bytes, rather than assume that there is equality. Its also important to +include the trailing `/` after the feed name. Including the slash prevents, say, +a `ADA-USDM` being used when only `ADA-USD` is desired. ### Verifying the created at