li3p/explain-func
skills/explain-func/SKILL.md
Add why-focused documentation to complex functions or code blocks. Use when the user asks to document dense logic, explain invariants, or add comments that help maintainers understand design intent.
development
Updated Apr 23, 2026
$ install --global
skillsauthnpx skillsauth add li3p/skills explain-funcInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 23, 2026, 11:10 PM40.8s1 file scanned
SKILL.md
- name:
- explain-func
- description:
- Add why-focused documentation to complex functions or code blocks. Use when the user asks to document dense logic, explain invariants, or add comments that help maintainers understand design intent.
Explain Function
Document the target function or code block: $ARGUMENTS
Documentation Rules
Write comments that explain why the code is shaped this way, not what each line does.
Document:
- non-obvious design choices
- invariants that future changes must preserve
- ordering constraints
- upstream or downstream limitations
- performance, compatibility, or data correctness tradeoffs
- gotchas that are not clear from reading the code
Avoid comments that simply restate code behavior.
Output
Add an appropriate docstring or documentation header with:
- purpose
- parameters and expected shapes
- return value
- errors or exceptional cases
- a short example only when usage is not obvious
Add inline comments only at points where a maintainer would otherwise need to reverse-engineer the reason for the implementation. Keep comments short and close to the code they clarify.
Do not change runtime logic.
Related Skills
li3p/notion-search
documentation
VerifiedTrustedCommunity
Search Notion for pages or databases by query using marknotion. Use when the user references a Notion page by name rather than URL, when locating a page to publish to or pull from, or when discovering what trackers and docs exist in the connected workspace.
SKILL.mdUpdated May 27, 2026
li3p/notion-pull
documentation
VerifiedTrustedCommunity
Export a Notion page to local Markdown using marknotion. Use when the user wants to pull a spec, design doc, meeting notes, or any Notion page into the repository as a Markdown file, or wants to read Notion content as context for a task.
SKILL.mdUpdated May 27, 2026
li3p/notion-publish
documentation
VerifiedTrustedCommunity
Publish a local Markdown file to a Notion page using marknotion. Use when the user wants to push README, docs, changelogs, or any Markdown content to Notion, either updating an existing page or creating a new one under a parent page.
SKILL.mdUpdated May 27, 2026
li3p/testmatch
testing
VerifiedTrustedCommunity
Generate tests that match an existing project's testing style. Use when adding coverage for a target file, function, bug fix, or edge case while preserving local conventions.
SKILL.mdUpdated Apr 23, 2026