Skip to content

Commit d84439a

Browse files
authored
docs: document _getDependencyData() directory parameter semantics (#476)
* docs: document _getDependencyData() directory parameter semantics Add JSDoc to Base_pyproject._getDependencyData() explaining that manifestDir is the project directory and workspaceDir is the lock file directory. Documents when each should be used by lock-file-based vs non-lock-file providers. Implements TC-4102 Assisted-by: Claude Code * docs: address review feedback on _getDependencyData JSDoc Remove caller reference, fix inaccurate fallback claim, and correct workspaceDir description to scope it to uv only (poetry ignores it). Implements TC-4102 Assisted-by: Claude Code * docs: drop obvious JS convention from JSDoc Implements TC-4102 Assisted-by: Claude Code
1 parent dcb2120 commit d84439a

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

src/providers/base_pyproject.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,10 @@ export default class Base_pyproject {
168168

169169
/**
170170
* Resolve dependencies using the tool-specific command and parser.
171+
*
171172
* @param {string} manifestDir - directory containing the target pyproject.toml
172-
* @param {string} workspaceDir - workspace root (where the lock file lives), or same as manifestDir for standalone projects
173+
* @param {string} workspaceDir - workspace root (where the lock file lives);
174+
* only used by providers that need workspace-level resolution (e.g. uv)
173175
* @param {object} parsed - parsed pyproject.toml
174176
* @param {Object} opts
175177
* @returns {Promise<DependencyData>}

0 commit comments

Comments
 (0)