Documentation says runTest(fn, options), which appears to be incorrect
- Langage dominant
- JavaScript
- Étoiles
- 1.9k
- Forks
- 359
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
Unless I am doing something incorrectly, the documentation is incorrect about `runTest`.
This is what the documentation says:
_Nodeunit exports runTest(fn, options), runModule(mod, options) and runFiles(paths, options)._
This is what I found when stepping through the code in the debugger:
```
exports.runTest = function (name, fn, opt, callback) {
// ... elided ...
};
```
This is what I was doing:
```
#!/usr/bin/env node
var nodeunit = require('nodeunit'),
reporter = nodeunit.reporters.default;
process.chdir(__dirname + '/..');
var testModule = require(__dirname + '/../test');
nodeunit.runTest(testModule.testBlockSizes, {});
//reporter.run(['test']);
```
which showed the following errors:
```
/usr/lib/node_modules/nodeunit/lib/types.js:177
opt[name] = opt[name] || function () {};
^
TypeError: Cannot read property 'moduleStart' of undefined
at optionalCallback (/usr/lib/node_modules/nodeunit/lib/types.js:177:24)
at Object.exports.options (/usr/lib/node_modules/nodeunit/lib/types.js:180:5)
at Object.exports.runTest (/usr/lib/node_modules/nodeunit/lib/core.js:62:25)
at Object. (/home/doug/Documents/Aptana Studio 3 Workspace/simplenode/filetolines/test/standalone.js:8:10)
at Module._compile (module.js:456:26)
at Object.Module._extensions..js (module.js:474:10)
at Module.load (module.js:356:32)
at Function.Module._load (module.js:312:12)
at Function.Module.runMain (module.js:497:10)
at startup (node.js:119:16)
```
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Piste de recherche
Repérez la phrase de la documentation qui décrit runTest(fn, options), puis comparez-la avec la signature d’exportation de runTest présentée dans lib/core.js et avec la gestion de options présentée dans lib/types.js. Mettez à jour la description de l’API et l’exemple afin qu’ils correspondent aux arguments implémentés ; le travail est terminé lorsque la signature documentée est correcte.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 45/100