Skip to content

Commit ec1b2e3

Browse files
committed
enforcing documentation for tested API
1 parent b5e9d6c commit ec1b2e3

File tree

1 file changed

+1
-1
lines changed
  • developer_manual/digging_deeper

1 file changed

+1
-1
lines changed

developer_manual/digging_deeper/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ testing version of the future API in the `NCT` namespace, following these rules:
2020
- Code from the `OCP` namespace must never mention anything coming from the `NCT` namespace. It can not require it as an argument, constant or return something from `NCT`.
2121
- An API can only live in this testing namespace for one major release.
2222
- During this testing phase, the code and the API can be modified/restructured without limitation.
23+
- API within the testing namespace must have up-to-date documentation.
2324
- If accepted, the API will be copied to the `OCP` public namespace.
2425
- Once tested, the version from the `NCT` namespace will be marked as deprecated.
2526
- Deprecated API from the `NCT` namespace are kept for 2 major releases.
2627

2728
.. note::
28-
- API within the testing namespace might not have documentation other than in-code comments.
2929
- API from `NCT` are included to the `nextcloud-deps/OCP` package for easier testing with psalm

0 commit comments

Comments
 (0)