Repository navigation
docs: name all five queue types in the package synopsis and README - #95
Merged
Merged
Conversation
The first sentence of the package doc is the pkg.go.dev description and still said there were four implementations. Name all five, including the delay queue, and use the terms people search for: ring buffer for the circular queue and FIFO for the linked queue, in the doc comment, the README intro, the headings and the decision table. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #95 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 6 6
Lines 552 552
=========================================
Hits 552 552
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
The first sentence of the package doc is what pkg.go.dev shows as the package description, and it still said "4 available implementations" after the Delay queue shipped in v1.7.0. It now names all five queue types and adds a paragraph for the delay queue. The README intro, the two headings, their table-of-contents anchors and the decision table pick up the terms people actually search for: "ring buffer" for the circular queue and "FIFO" for the linked queue. No code changes.
The GitHub repo description and topics were updated alongside this in the repo settings.