Define & Document a function name prefix for core use in plugins
Open
documentation
Plugins
- Dominant language
- Python
- Stars
- 1.3k
- Forks
- 182
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
i.e. we have `journal_entry()` now and a proposed `journal_entry_cqc()` (see #1030 ). But what if a plugin developer already has that function name in their code, with matching number of arguments?
We need to define a prefix for function names that plugin developers know not to use, and then always use it ourselves for any new API function names.
Contributor guide
Research direction
Start by reviewing the existing plugin-facing functions, including journal_entry() and the proposed journal_entry_cqc() from issue #1030. Define a reserved prefix that plugin developers are told not to use, document the convention, and identify how future core API names will follow it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design, developer-experience
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100