Is it possible to rename $0 when documenting destructured params?

[aaronjensen]

It's possible to name the parts of $0, which is great, but it'd be nice if I could name $0 itself. Is this possible?

[tmcw]

Sorry, currently that's not possible. The relevant code is

documentation/lib/infer/params.js

Lines 203 to 227 in f07285a

	path.node.params
	.reduce(function (params, param, i) {
	return params.concat(paramToDoc(param, comment, i, ''));
	}, [])
	.forEach(function (doc) {
	if (!existingParams.hasOwnProperty(doc.name)) {
	// This type is not explicitly documented
	comment.params = insertBeforeDependents(doc, comment.params);
	} else if (!existingParams[doc.name].type) {
	// This param has a description, but potentially it can
	// be have an inferred type. Infer its type without
	// dropping the description.
	if (doc.type) {
	existingParams[doc.name].type = doc.type;
	}
	} else if (existingParams[doc.name].type.type !== 'OptionalType' &&
	doc.default) {
	existingParams[doc.name].type = {
	type: 'OptionalType',
	expression: existingParams[doc.name].type,
	default: doc.default
	};
	}
	paramOrder[doc.name] = i++;
	});

We're handling:

• Inferring names of parameters
• Combining inferred types with parameters also declared with @param for named arguments
• Inferring default values for optional parameters

But we don't yet support naming destructuring params, but I'd be overjoyed to review a PR implementing such support. Most likely it'd, instead of indexing params by name and matching them that way, as we do currently, would assume that if someone uses @param explicit tags, they're going to provide them in the correct order and we should match them one by one with inferred information.

[tmcw]

This will be fixed in #732 - in fact, it'll be required that to refer to inferred destructuring arguments, you need to name them.