node-param-description-wrong-for-return-all.md

node-param-description-wrong-for-return-all

description for Return All node parameter must be Whether to return all results or only up to a given limit

📋 This rule is part of the plugin:n8n-nodes-base/nodes config.

🔧 Run ESLint with --fix option to autofix the issue flagged by this rule.

Examples

❌ Example of incorrect code:

const test = {
	displayName: "Return All",
	name: "returnAll",
	type: "boolean",
	default: true,
	description: "Wrong",
};

✅ Example of correct code:

const test = {
	displayName: "Return All",
	name: "returnAll",
	type: "boolean",
	default: true,
	description: "Whether to return all results or only up to a given limit",
};

Links

• Rule source
• Test source