From bc3099c19b6f5de3299966a0f97fe2bace8f95a1 Mon Sep 17 00:00:00 2001
From: a
Date: Sat, 15 Jun 2024 20:03:55 +0000
Subject: [PATCH] Fix formatting error in README for term definitions (#331)
Codeberg's flavour of markdown requires a line break between terms in description lists
Reviewed-on: https://codeberg.org/fediverse/fep/pulls/331
Co-authored-by: a
Co-committed-by: a
---
fep/0391/contextProof/README.md | 1 +
fep/0391/inReplyToProof/README.md | 1 +
.../{relationshipProof.txt => README.md} | 19 ++++++++++++++-----
fep/888d/exampleA/README.md | 1 +
fep/888d/exampleB/README.md | 1 +
fep/888d/exampleC/README.md | 1 +
6 files changed, 19 insertions(+), 5 deletions(-)
rename fep/0391/relationshipProof/{relationshipProof.txt => README.md} (93%)
diff --git a/fep/0391/contextProof/README.md b/fep/0391/contextProof/README.md
index e29a29c..2e5387d 100644
--- a/fep/0391/contextProof/README.md
+++ b/fep/0391/contextProof/README.md
@@ -4,6 +4,7 @@ Provides proof that some object was added to some `context` collection
Domain
: Object with context set to a Collection that has attributedTo set
+
Range
: Add
diff --git a/fep/0391/inReplyToProof/README.md b/fep/0391/inReplyToProof/README.md
index 59a6b78..119c940 100644
--- a/fep/0391/inReplyToProof/README.md
+++ b/fep/0391/inReplyToProof/README.md
@@ -4,6 +4,7 @@ Provides proof that some object was added to the replies collection of some inRe
Domain
: Object with inReplyTo set to an Object that has a replies collection
+
Range
: Add
diff --git a/fep/0391/relationshipProof/relationshipProof.txt b/fep/0391/relationshipProof/README.md
similarity index 93%
rename from fep/0391/relationshipProof/relationshipProof.txt
rename to fep/0391/relationshipProof/README.md
index 94551cd..3175733 100644
--- a/fep/0391/relationshipProof/relationshipProof.txt
+++ b/fep/0391/relationshipProof/README.md
@@ -1,13 +1,19 @@
-relationshipProof
+# relationshipProof
Provides proof that the current relationship is reciprocally claimed.
-Domain: Relationship
-Range: Relationship | Add | Follow? | Accept Follow?
-Status: Experimental
+Domain
+: Relationship
+
+Range
+: Relationship | Add | Follow? | Accept Follow?
+
+Status
+: Experimental
Example 1:
+```json
{
"@context": ["https://www.w3.org/ns/activitystreams", "https://w3id.org/fep/0391"],
"id": "https://example.com/some-relationship",
@@ -57,9 +63,11 @@ Example 1:
}
]
}
+```
Example 2:
+```json
{
"@context": ["https://www.w3.org/ns/activitystreams", "https://w3id.org/fep/0391"],
"id": "https://example.com/some-relationship",
@@ -104,4 +112,5 @@ Example 2:
"object": "https://example.com/actors/1"
}
]
-}
\ No newline at end of file
+}
+```
\ No newline at end of file
diff --git a/fep/888d/exampleA/README.md b/fep/888d/exampleA/README.md
index 8c1c46f..a169ea3 100644
--- a/fep/888d/exampleA/README.md
+++ b/fep/888d/exampleA/README.md
@@ -4,6 +4,7 @@ A property with some literal value (string, boolean, number)
Domain
: SomeType
+
Range
: String or Boolean or Number
diff --git a/fep/888d/exampleB/README.md b/fep/888d/exampleB/README.md
index e2235dd..3e62a71 100644
--- a/fep/888d/exampleB/README.md
+++ b/fep/888d/exampleB/README.md
@@ -4,6 +4,7 @@ A property that links to another node on the graph (for example, another object)
Domain
: SomeType
+
Range
: @id
diff --git a/fep/888d/exampleC/README.md b/fep/888d/exampleC/README.md
index 0418869..029408b 100644
--- a/fep/888d/exampleC/README.md
+++ b/fep/888d/exampleC/README.md
@@ -4,6 +4,7 @@ A property that is an ordered list of literal values that are specifically non-n
Domain
: SomeType
+
Range
: List of nonNegativeInteger