javascript-tools-guide icon indicating copy to clipboard operation
javascript-tools-guide copied to clipboard

`EditNumber` control added to documentation.

Open SetTrend opened this issue 3 years ago • 8 comments

The Adobe Photoshop script "Image Processor.jsx" at C:\Program Files\Adobe\Adobe Photoshop 2022\Presets\Scripts comes with an editnumber control for entering numerical values.

That editnumber control is currently undocumented. This pull request adds the corresponding documentation.

SetTrend avatar Mar 13 '22 01:03 SetTrend

Hi @SetTrend thanks for the PR! Can you add a warning that this is undocumented? More info here

Klustre avatar Mar 14 '22 13:03 Klustre

Other considerations and notes that should be added: does this work in every hostapp? How long has this been part of Extendscript?

If it's only specific to Photoshop 22+, then a warning should be added noting this.

zlovatt avatar Mar 14 '22 17:03 zlovatt

Hi @SetTrend thanks for the PR! Can you add a warning that this is undocumented? More info here

Thanks, @Klustre, for taking the time!

Where would you want me to add this warning?

Would you mind going to this PR's "Files changed" tab and click on a code line in the right code panel where you want me to add the warning? Then I can easily comply to your review comment from there.

Other considerations and notes that should be added: does this work in every hostapp? How long has this been part of Extendscript?

If it's only specific to Photoshop 22+, then a warning should be added noting this.

@zlovatt: This is something only an Adobe employee can answer. I'm just a user trying to help. I don't have any insights of when or where this feature was added by Adobe.

SetTrend avatar Mar 15 '22 22:03 SetTrend

@SetTrend This doesn't exist in core Extendscript, AE, AI, or ID.

I don't keep other hostapps installed, so can't check those-- but so far it seems this is PS only. Can you add an admonition detailing this, in all the places you mention editnumber?

zlovatt avatar Jun 17 '22 19:06 zlovatt

HI @zlovatt,

sure! Would you want to provide me with the type of admonition to use? What would you suggest should the admonition's text be to fit your requirements?

SetTrend avatar Jun 18 '22 05:06 SetTrend

@SetTrend See the "Admonitions Usage" section of the readme for how to use admonitions.

In this case, a "Note" would be consistent with other docs; something like this:

.. note::
	This functionality was added in Photoshop XX.X (CC XX).

zlovatt avatar Jul 25 '22 19:07 zlovatt

Done. I've now added notes to all places where EditNumber is mentioned.

SetTrend avatar Aug 03 '22 15:08 SetTrend

I know I gave you the boilerplate message there, but could you update it so it reflects that it was only added to Photoshop, and that it doesn't exist anywhere else? Went to approve and felt that it'd be misleading to not make that super explicit. Sorry!

zlovatt avatar Apr 25 '23 16:04 zlovatt