Skip to content

Commit

Permalink
Move "A note ..." section into main Relationships section
Browse files Browse the repository at this point in the history
  • Loading branch information
HebaruSan committed Nov 22, 2023
1 parent 5e13f45 commit c3ed6aa
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions Spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -575,6 +575,17 @@ depends:
suppress_recommendations: true
```

In the interest of the end-user experience, the relationship metadata
*should* only be used when a game-related relationship exists between
the mods. They do not have to directly interact, but the rationale should be
apparent. It *should not* be used purely for promotional purposes. This is
consistent with [the Debian spec], which states:

> tells the ... user that the listed packages are related to this one and can
perhaps enhance its usefulness

[the Debian spec]: https://www.debian.org/doc/debian-policy/ch-relationships.html

##### depends

A list of mods which are *required* for the current mod to operate.
Expand Down Expand Up @@ -620,17 +631,6 @@ replaced_by differs from other relationships in two ways:
- It is *not* an array. Only a single mod can be defined as the replacement.
- Only "version" and "min_version" are permitted as options.

#### A note on relationships

In the interest of the end-user's experience, the relationship metadata
*should* only be used when an actual game-related relationship exists between
the mods. They do not have to directly interact but the rationale should be
apparent. It *should not* be used purely for promotional purposes. This is
consistent with the Debian spec which states:

> tells the ... user that the listed packages are related to this one and can
perhaps enhance its usefulness

#### Resources

The `resources` field describes additional information that a user or
Expand Down

0 comments on commit c3ed6aa

Please sign in to comment.