element-hq / element-hq/synapse

Terminology for third-party modules is confusing

Open
#12,186 0 comments 0 reactions 0 assignees View on GitHub
A-Docs A-Modules T-Other
Dominant language
Python
Stars
4.6k
Forks
600
Avg merge
5d 22h
Merged PRs (30d)
51

Description

This issue has been migrated from [#12186](https://github.com/matrix-org/synapse/issues/12186).

---

Currently we have a module _system_ (or _interface_) where modules can register _callbacks_ and use module _API methods_, which are different things. It feels like we keep confusing them, for example calling a module callback a module API (which is even more confusing because it technically _is_ an API but just isn't a method of the `ModuleApi` class).

We need to figure out a better terminology.

Contributor guide

Open the contributing guide

Research direction

The issue mentions the module system/interface, module callbacks, module API methods, and the ModuleApi class, but no files or tests. Start by locating those entry points and cataloguing how each term is used. Done means agreeing on clearer terminology and applying it consistently across the relevant module documentation and code references.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.