Skip to content

Commit 2162964

Browse files
committed
Add note
1 parent 2eee11a commit 2162964

File tree

1 file changed

+1
-0
lines changed
  • lib/node_modules/@stdlib/_tools/pkgs/namespaces

1 file changed

+1
-0
lines changed

lib/node_modules/@stdlib/_tools/pkgs/namespaces/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ The function accepts the same `options` as `ls()` above.
128128

129129
- Both functions **only** return namespaces under the `@stdlib` scope.
130130
- Both functions **always** ignore `examples/fixtures`, `test/fixtures`, and `benchmark/fixtures` directories, irrespective of whether an `ignore` option is provided.
131+
- Be **careful** when using the `pattern` option. Both functions first resolve a list of packages matching the search criteria and then prune the list to resolve "namespaces" relative to the resolved list. For example, if the `pattern` option results in resolving only a single package, both functions will always fail to resolve a namespace, regardless as to whether the package actually is a namespace. Only when both functions resolve leaf packages will the functions resolve namespaces.
131132

132133
</section>
133134

0 commit comments

Comments
 (0)