Mention jsdoc/util/error.js in the plugin docs

[hegemonic]

The plugin docs should mention the handle() function in jsdoc/util/error.js, which either throws an error or logs a warning to the console, depending on whether the --lenient option is used.

[mathematicalcoffee]

I still have no idea how to contribute to this repository (despite some hints from matthewkastor I still can't get compiling the jsdoc3 documentation to work).

However I can provide some markdown that can be added to the appropriate places (or you could tell me exactly which files to modify and I can do it):

Add into plugins/README.md and to the usejsdoc website on the 'about-plugins' page - either as a section under 'Authoring JSDoc 3 Plugins' or perhaps as a sibling to it. Markdown:

### Throwing Errors
If you wish your plugin to throw an error, do it using the `handle` function in the `jsdoc/util/error` module:

    require('jsdoc/util/error').handle( new Error('I do not like green eggs and ham!') );

By default this will throw the error, halting the execution of `jsdoc`. However, if the user used the `--lenient` switch when they ran `jsdoc` it will simply log the error to the console and continue.

Rendered output:

Throwing Errors

If you wish your plugin to throw an error, do it using the handle function in the jsdoc/util/error module:

require('jsdoc/util/error').handle( new Error('I do not like green eggs and ham!') );

By default this will throw the error, halting the execution of jsdoc. However, if the user used the --lenient switch when they ran jsdoc it will simply log the error to the console and continue.

[mathematicalcoffee]

Could you give me more information about how to contribute to the documentation even if I can't compile any of it?

Is it sufficient for me to just modify the files in Jake/articles and submit a pull request, even if running jake doesn't work for me?

Also, I have to write the documentation in HTML rather than Markdown (well, I can use an editor to copy the HTML output of Markdown)? Should I attempt to conform to that weird indented format of the HTML?

cheers

[hegemonic]

@mathematicalcoffee, I'm sorry you're having so much trouble getting the doc build to work! Could you tell me what error message you get when you run jake on the latest HEAD for this repo? If we can't sort out the error, you could always just update the source files, but obviously it'd be nice if you could do both.

And yep, everything's in HTML for now, although it'd be great to switch to Markdown at some point. For now, I wouldn't sweat the indentation too much.

[mathematicalcoffee]

.....I totally forgot to pull from upstream before running jake.

It works!

booya, I can finally be let loose on the documentation! In the words of the Mask ... Somebody stop me!

[micmath]

I am definitely not going to to stop @mathematicalcoffee

[hegemonic]

I wouldn't dare to try.