Feature Request: Document method functionality in detail

Ashung / Automate-Sketch

Make your workflow more efficient.

MIT License

934 stars 73 forks source link

Feature Request: Document method functionality in detail #125

Open semiconducted opened 5 years ago

semiconducted commented 5 years ago

The current documentation simply reiterates the name of the action. What would be helpful is to explain with much more detail the process of the method/function.

explain what object types it expects, what it WILL and WON'T work on
how to use it
how the action works

Something like: 'Loops through all Layers - selected and unselected - on all Artboards on the current Page, copying any Styles in a separate linked Library to the current Sketch file and setting each Layer's Style to the Style in the local file.

Expected input: Single Selected Page
Affects: Text Layers, Object Layers
Ignores: Local Symbols, Library Symbols'

creativechris08 commented 5 years ago

🙏

TylerFAnderson commented 5 years ago

second this, I feel like i am missing out on great time savers because I dont know what they do which defeats the whole purpose of making them great in the first place.

CraigReville commented 5 years ago

I'm happy to help document, just need to know what they actually do, I'll create a sheet later and list everything out

EDIT I've created this spreadsheet and I'll start updating it with more content as I play with each feature, feel free to update.

AS: Documentation - Features

semiconducted commented 5 years ago

@CraigReville Thanks for setting up the spreadsheet. Since the current description is pulled right from the code, I've added a new column for the Editor's rewrite.

I've only done one of them so far, but the process is super easy and accessible to ANYONE out there who can help. All you need to do is just test a feature with different objects selected and write down what works and what doesn't.

TylerFAnderson commented 5 years ago

I'm gonna this a go.