Hammerspoon/hammerspoon

Need hs.window.filter examples in the Getting Started Guide

Open

#1292 opened on Mar 30, 2017

View on GitHub
 (0 comments) (3 reactions) (0 assignees)Objective-C (15,415 stars) (688 forks)batch import
docsenhancementhelp wanted

Description

I don't particularly use hs.window.filter myself, but it is incredibly powerful, and I think it can be a little daunting to just have the API docs.

So, would anyone who uses window filters, care to share some snippets of their config, so we can work up good introductory examples for the Getting Started Guide?

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of HammerspoonFamiliarity with hs.window.filter API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Collect example snippets from users or create new ones demonstrating usage of hs.window.filter. Incorporate them into the Getting Started Guide (likely in the Hammerspoon repository's documentation folder). Review existing API docs for context. Since there are no comments or linked PRs, maintainer feedback may be needed to confirm the format.