asmvik / asmvik/skhd

Implementing an Uberischt widget for displaying inline docstrings in skhdrc files

Open
#110 6 comments 0 reactions 0 assignees View on GitHub
question
Dominant language
C
Stars
8.1k
Forks
241
PR merge metrics
No merged PRs in 30d

Description

Hi, I'm planning on writing a simple widget that parses inline docstrings (Probably regular comments with a leading character to indicate its a docstring, like `#'` or something).

I was wondering if, once done, you'd be open to linking to it from the readme?
Also, I was wondering if you had suggestions for the syntax, I was thinking something like:

```
#' ${cmd} + alt - 1 : Go to workspace 1
#' ${cmd} + alt - n : Go to workspace n
```
https://github.com/koekeishiya/skhd/blob/01722fcf49a5826392010504162bc63e2b01c423/examples/skhdrc#L170-L179

Displaying as:

⌘ + alt - 1 : Go to workspace 1
⌘ + alt - n : Go to workspace n

Or something, where cmd is escaped one way or another and automatically parsed to ⌘

& perhaps following markdown syntax in all other regards.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the example skhdrc entry at lines 170–179 and the repository README, then clarify the proposed inline docstring syntax and how the external Uberischt widget should parse it. Done would mean a defined widget behavior and a decision on whether and how it should be linked from the README.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.