docs(proc-docs): Add proc-doc blocks to all non-trivial functions#4
Merged
docs(proc-docs): Add proc-doc blocks to all non-trivial functions#4
Conversation
Add standardized proc-doc blocks (79-char header format) to functions across dotfiles and tools: - tools/compile.sh: 10 functions (run_tests, read_version, bump_patch_version, update_citation_for_release, update_changelog_for_release, generate_release_notes, prompt_commit_msg, do_commit_and_push, do_release, main) - dotfiles/ssh.aliases.sh: sshfs_mount, sshfs_unmount - dotfiles/screen.aliases.sh: screen, does_screen_session_exist, exec_cmd_in_screen_session, exec_on_all_screen_sessions, find_leaves, truncate_string, show_all_screen_commands_and_select - dotfiles/tmux.aliases.sh: tmux, tmuxS, does_tmux_session_exist, exec_cmd_in_tmux_session, exec_on_all_tmux_sessions, create_tmux_session, t - dotfiles/capture_traffic.sh: check_tshark, parse_capture_args, capture_traffic - dotfiles/combined.history.sh: trace_run, test_logging_setup - dotfiles/tgt.aliases.sh: getTGT, saveTGT, listTGT, validateTGT, exportTGT, renewTGT, renewAllTGT, testTGTs, validateAllTGT - dotfiles/bash.env.sh: _check_command Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add standardized proc-doc blocks (79-char header format) to functions across dotfiles and tools:
tools/compile.sh: 10 functions (run_tests, read_version, bump_patch_version, update_citation_for_release, update_changelog_for_release, generate_release_notes, prompt_commit_msg, do_commit_and_push, do_release, main)
dotfiles/ssh.aliases.sh: sshfs_mount, sshfs_unmount
dotfiles/screen.aliases.sh: screen, does_screen_session_exist, exec_cmd_in_screen_session, exec_on_all_screen_sessions, find_leaves, truncate_string, show_all_screen_commands_and_select
dotfiles/tmux.aliases.sh: tmux, tmuxS, does_tmux_session_exist, exec_cmd_in_tmux_session, exec_on_all_tmux_sessions, create_tmux_session, t
dotfiles/capture_traffic.sh: check_tshark, parse_capture_args, capture_traffic
dotfiles/combined.history.sh: trace_run, test_logging_setup
dotfiles/tgt.aliases.sh: getTGT, saveTGT, listTGT, validateTGT, exportTGT, renewTGT, renewAllTGT, testTGTs, validateAllTGT
dotfiles/bash.env.sh: _check_command
Pull Request Template for the Bash_setup Project
Description
Please provide a summary of the changes made, including:
Type of Change
Please select the type of change by marking the relevant option(s) with
[x]:How Has This Been Tested?
Describe the tests you ran to verify your changes, including:
bash --version).Testing Checklist:
Screenshots (If Applicable)
If the changes involve user-facing functionality or outputs, please include before and after screenshots to help reviewers understand the impact of the change.
Checklist
Please complete the checklist below to ensure your PR meets the project standards:
shellcheckusing the repository's.shellcheckrcfile to verify linting:shfmt:shfmt -i 4 -ci -bn -kp -sr -ln bash -d .Additional Notes
If your changes rely on external tools or third-party dependencies, please include details about:
This PR template is designed to ensure contributions to the bash_setup project are clear, well-tested, and maintainable. Thank you for your contribution!