node-red-web-nodes icon indicating copy to clipboard operation
node-red-web-nodes copied to clipboard

Dropbox node HTML help to be revised

Open zobalogh opened this issue 11 years ago • 1 comments
trafficstars

@hindessm , I've been looking at the description of the Dropbox nodes. I personally believe, they could be clearer and updated.

The most confusing one is the Dropbox query node. The first sentence of the description says "Dropbox input node". I think a different term should be invented for similar nodes or the action described better.

For the Dropbox input node, is "watch node" a defined term? How about "glob pattern"?

I would also prefer to read text split into paragraphs.

I hope I'm not too harsh here, what do you think?

zobalogh avatar Oct 27 '14 16:10 zobalogh

The most confusing one is the Dropbox query node. The first sentence of the description says "Dropbox input node".

I intended it to match the equivalent file node. So, strictly, it should be "in" but when I came to type it my fingers seem to have decided "input" was clearer/better. I'm happy to standardize on "in" (and change the s3/box.com/dropbox nodes) or change the file node to use "input" according to @knolleary's preference.

For the Dropbox input node, is "watch node" a defined term?

I named this to match the existing "Watch" node that you should fine in your palette? I think it makes sense to stick with this unless you have a good reason not to?

How about "glob pattern"?

I think this is a standard term so does wikipedia but I may not be a typical node-red user. If you think it needs further explanation then perhaps we should link to the variant used in the implementation - minimatch?

I would also prefer to read text split into paragraphs.

Is this a general comment or did you have something specific in mind? I generally use paragraphs in longer prose or where there is a natural change of context. I don't think any of the dropbox text is more than two or three sentences so I don't see an obvious need for paragraph breaks.

I hope I'm not too harsh here, what do you think?

Not too harsh but it would be constructive to be more specific and/or suggest actual changes - perhaps in a pull request - use separate commits for each distinct "improvement" to make it easier to discuss them.

hindessm avatar Oct 28 '14 08:10 hindessm