Skip to content

Commit cc66ac4

Browse files
committedFeb 24, 2025
docs: update step to include removing symbol from namespace type declarations
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent c5feaab commit cc66ac4

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed
 

‎docs/contributing/moving_packages.md

+38
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,44 @@ If that file includes an exported symbol from the original package, remove it. F
193193
- setReadOnly( ns, 'dmax', require( '@stdlib/stats/base/dmax' ) );
194194
```
195195

196+
Next, open the `docs/types/index.d.ts` file found in the parent namespace of the original package (e.g., `lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts`).
197+
198+
If that file includes an exported symbol from the origin package, remove it. For example,
199+
200+
```diff
201+
- import dmax = require( '@stdlib/stats/strided/dmax' );
202+
```
203+
204+
and
205+
206+
```diff
207+
- /**
208+
- * Computes the maximum value of a double-precision floating-point strided array.
209+
- *
210+
- * @param N - number of indexed elements
211+
- * @param x - input array
212+
- * @param strideX - stride length
213+
- * @returns minimum value
214+
- *
215+
- * @example
216+
- * var Float64Array = require( '@stdlib/array/float64' );
217+
- *
218+
- * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
219+
- *
220+
- * var v = ns.dmax( x.length, x, 1 );
221+
- * // returns 2.0
222+
- *
223+
- * @example
224+
- * var Float64Array = require( '@stdlib/array/float64' );
225+
- *
226+
- * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
227+
- *
228+
- * var v = ns.dmax.ndarray( x.length, x, 1, 0 );
229+
- * // returns 2.0
230+
- */
231+
- dmax: typeof dmax;
232+
```
233+
196234
### 7. Commit the changes to the parent namespace
197235

198236
If you removed an exported symbol from the parent namespace, commit those changes, making note that this is a breaking change.

0 commit comments

Comments
 (0)
Failed to load comments.