@@ -146,14 +146,17 @@ so that they are documented but don't appear in the main index.
146146
147147Reviews should point out where existing public APIs are broken.
148148
149- ### Deprecation and API lifecycle
149+ ### API lifecycle and deprecations
150150
151151` cuda.core ` follows SemVer (see ` docs/source/support.rst ` ):
152152
153- - ** New APIs** may be added at any time (` x.Y.0 ` ).
153+ - ** New APIs** may be added at any time (` x.Y.0 ` ). They MUST have a
154+ ` @versionadded ` decorator, unless the docstring formatting requires it to be
155+ manually-specified.
154156- ** Breaking removals** only happen in ** major releases** (` X.0.0 ` ).
155157- Per the support policy, a deprecation notice must be present for ** at least
156- one minor release** before the API is actually removed.
158+ one minor release** before the API is actually removed. The deprecation notice
159+ should use the ` @deprecated ` decorator, unless
157160- Changes should be notated in the code and also in the release notes in the
158161 "Deprecated APIs" section.
159162
@@ -215,7 +218,7 @@ generated docs.
215218``` python
216219from cuda.core._vendored.deprecated.sphinx import deprecated
217220
218- @deprecated (version = " 1.2.0" , reason = " Use `new_feature` instead." )
221+ @deprecated (version = " 1.2.0" , reason = " Use `new_feature` instead." )`
219222def old_feature (...):
220223 """ Short description.
221224 """
@@ -237,5 +240,9 @@ removing, verify that the deprecation has been present since at least the
237240previous minor release. Remove the decorator, the implementation, and any
238241` __all__ ` entry; update ` api.rst ` and the release notes accordingly.
239242
240- At some point in the future, we will provide automation for removal of
241- deprecated APIs.
243+ ## Vendored code
244+
245+ The ` cuda/core/_vendored ` directory contains vendored code from third-party
246+ sources. It should not be modified, except to update the dependency or under
247+ exceptional circumstances, in which case any modifications should be clearly
248+ marked.
0 commit comments