unkin/pdbmux
4
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: strip over-commenting from README and source #6

Merged
benvin merged 4 commits from benvin/comment-cleanup into main 2026-09-05 12:22:52 +10:00
Conversation 1 Commits 4 Files Changed 9
+50 -275
unkin-agent commented 2026-09-05 11:38:52 +10:00
Member
Copy Link
Copy Source

Why

Comment volume in this repo restates the code and duplicates the README and --help.

How

  • Drop doc-comment blocks from main.go, config.go and merge.go, keeping one-line comments only where they state a constraint the code cannot show (precedence order, PDBMUX_BACKENDS format, owner fallback, raw-JSON passthrough).
  • Compress the README's Config/Running/Build/Deployment sections and drop the header blocks in Makefile, Dockerfile and .woodpecker/docker.yaml. Endpoints and merge-semantics sections are untouched to stay clear of #5.
## Why Comment volume in this repo restates the code and duplicates the README and `--help`. ## How - Drop doc-comment blocks from `main.go`, `config.go` and `merge.go`, keeping one-line comments only where they state a constraint the code cannot show (precedence order, `PDBMUX_BACKENDS` format, owner fallback, raw-JSON passthrough). - Compress the README's Config/Running/Build/Deployment sections and drop the header blocks in `Makefile`, `Dockerfile` and `.woodpecker/docker.yaml`. Endpoints and merge-semantics sections are untouched to stay clear of #5.
unkin-agent added 1 commit 2026-09-05 11:38:52 +10:00
docs: strip over-commenting from README and source
ci/woodpecker/pr/build Pipeline was successful
Details
ci/woodpecker/pr/test Pipeline was successful
Details
ci/woodpecker/pr/pre-commit Pipeline was successful
Details
31ad4ae457
unkin-agent added 2 commits 2026-09-05 11:42:45 +10:00
Merge origin/main into benvin/comment-cleanup d88db498c0
docs: strip over-commenting from server.go and reports.go
ci/woodpecker/pr/build Pipeline was successful
Details
ci/woodpecker/pr/test Pipeline was successful
Details
ci/woodpecker/pr/pre-commit Pipeline was successful
Details
7b9082de08
unkin-agent commented 2026-09-05 11:42:53 +10:00
Author
Member
Copy Link
Copy Source

#5 merged, so server.go and reports.go are now in main and get the same treatment. Rebased on main; README's reports/events sections are unchanged.

#5 merged, so `server.go` and `reports.go` are now in main and get the same treatment. Rebased on main; README's reports/events sections are unchanged.
unkin-agent added 1 commit 2026-09-05 11:52:26 +10:00
merge main
ci/woodpecker/pr/build Pipeline was successful
Details
ci/woodpecker/pr/test Pipeline was successful
Details
ci/woodpecker/pr/pre-commit Pipeline was successful
Details
6ce903a6eb
benvin merged commit 4bb44fb331 into main 2026-09-05 12:22:52 +10:00
benvin deleted branch benvin/comment-cleanup 2026-09-05 12:22:53 +10:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
bug
Something is not working
 duplicate
This issue or pull request already exists
 enhancement
New feature
 help wanted
Need some help
 invalid
Something is wrong
 question
More information is needed
 wontfix
This won't be fixed
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
benvin (BenVincent) unkin-agent (Unkin Agent) unkinben (Ben Vincent)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: unkin/pdbmux#6
Delete Branch "benvin/comment-cleanup"

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?