#39 Generalize 'description' and move elsewhere

Open
opened 11 months ago by fr33domlover · 0 comments

There's a description property used for specifying the optional description of a commit. But this property can surely be used in many other cases, to provide human- or machine-written textual descriptions of objects. The current standard options are:

  • summary: Required to be HTML
  • content: Specifies the essence of the object, while description just refers to separate essence defined in other properties, or even outside of ActivityPub (for example a Banana may have a description, but it doesn't make much sense for it to have content, or summary).

If there's an existing description property in some ontology such as DOAP or DC etc., we could reuse it here (if the thing with mediaType works out; it would likely mean we drop mediaType and just always treat it as plain text, which is hopefully fine). IIRC I added mediaType there because the GAnarchy person mentioned treating the description as Markdown, so there's a use case for varying media type.

There's a `description` property used for specifying the optional description of a commit. But this property can surely be used in many other cases, to provide human- or machine-written textual descriptions of objects. The current standard options are: - `summary`: Required to be HTML - `content`: Specifies the essence of the object, while `description` just refers to separate essence defined in other properties, or even outside of ActivityPub (for example a `Banana` may have a `description`, but it doesn't make much sense for it to have `content`, or `summary`). If there's an existing `description` property in some ontology such as DOAP or DC etc., we could reuse it here (if the thing with `mediaType` works out; it would likely mean we drop `mediaType` and just always treat it as plain text, which is hopefully fine). IIRC I added `mediaType` there because the GAnarchy person mentioned treating the description as Markdown, so there's a use case for varying media type.
Sign in to join this conversation.
Loading...
Cancel
Save
There is no content yet.