rootiest/fish-config
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(functions): add category metadata to undocumented functions #91

Merged
rootiest merged 1 commits from feat-function-categories into main 2026-07-28 00:07:22 +00:00
Conversation 0 Commits 1 Files Changed 9
+152 -2
rootiest commented 2026-07-28 00:04:47 +00:00
Owner
Copy Link
Copy Source

This PR adds # CATEGORY metadata to 8 functions (fast, fast-cli, fish_mode_prompt, fish_prompt, fish_right_prompt, fzf_configure_bindings, sponge_filter_secrets, zoxide) to resolve the verify-manual.py warning. For zoxide.fish, which only contains internal completions starting with _, the # SYNOPSIS blocks were changed to # INTERNAL SYNOPSIS to prevent the test from flagging the file as an undocumented public function.

This PR adds `# CATEGORY` metadata to 8 functions (`fast`, `fast-cli`, `fish_mode_prompt`, `fish_prompt`, `fish_right_prompt`, `fzf_configure_bindings`, `sponge_filter_secrets`, `zoxide`) to resolve the `verify-manual.py` warning. For `zoxide.fish`, which only contains internal completions starting with `_`, the `# SYNOPSIS` blocks were changed to `# INTERNAL SYNOPSIS` to prevent the test from flagging the file as an undocumented public function.
rootiest added 1 commit 2026-07-28 00:04:48 +00:00
docs(functions): add category metadata to undocumented functions d2f3da4a23
rootiest merged commit d91c0c8deb into main 2026-07-28 00:07:22 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
rootiest (Rootiest)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: rootiest/fish-config#91
Delete Branch "feat-function-categories"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?