w3c / w3c/activitystreams

In Vocabulary, use "Object | Link" rather than "Link | Object" (Proposed Errata)

Open
#554 3 comments 0 reactions 1 assignee View on GitHub

@evanp is already working on this.

Since Nov 15, 2023.

editorial Editorial (would not change implementations)
Dominant language
HTML
Stars
313
Forks
70
PR merge metrics
No merged PRs in 30d

Description

Please Indicate One:

  • [ x] Editorial
  • Question
  • Feedback
  • Blocking Issue
  • Non-Blocking Issue

Please Describe the Issue:

In the ActivityStreams Vocabulary's listing of Terms, the Range and Domain descriptions are defined sometimes as "Object | Link" and sometimes as "Link | Object." Given that "Object | Link" and "Link | Object" are semantically identical, unnecessary apparent specification complexity would be reduced by adopting a consistent method of expressing this conjunction.

I suggest that the Domain and Range descriptions of attributedTo, and preview; and the Range descriptions of mediaType, and subject should be changed from "Link | Object" to "Object | Link." Prior to these changes actually being made, they should be recorded as Errata.

Why "Object | Link" rather than "Link | Object"?

  • "Object | Link" is used 25 times in the current version while "Link | Object" is used only 6 times. - The impact of this proposed change would be limited by adopting the form which is currently most commonly used.
  • "Object" is more general than "Link" - It seems natural to list options in decreasing order of generality, it makes sense to use "Object | Link" as the preferred pattern

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.