Skip to content

docs(readme): polish intro, quickstart, bottom matter, and example consistency#63

Merged
adrianbrad merged 1 commit intomainfrom
docs/readme-polish
Apr 21, 2026
Merged

docs(readme): polish intro, quickstart, bottom matter, and example consistency#63
adrianbrad merged 1 commit intomainfrom
docs/readme-polish

Conversation

@adrianbrad
Copy link
Copy Markdown
Owner

Apply README gaps identified against standard-readme + a review pass over the existing examples.

Top matter

  • Replace three-sentence intro with a one-line tagline.
  • Add a Features bullet list.
  • Surface pkg.go.dev as a prominent body link.

New sections

  • Quick start snippet between Import and Choosing a queue.
  • Contributing, Security, License at the bottom, each linking to the file already in the repo.
  • Maintainer callout.

Per-queue example fixes

  • Linked Queue: variable was named circularQueue (copy-paste from Circular) — renamed to linkedQueue.
  • Priority Queue: misaligned closing paren; "comparator function" → "less function" (matches code).
  • Blocking Queue: switched Println("elem: ", elem) to Printf("elem: %d\n", elem)Println inserts a space between operands, so the old elem: 2 comment was actually wrong.
  • Normalised indentation of all code samples to tabs.

Nits

  • Trailing whitespace on a couple of lines.
  • Trailing space in the ## Benchmarks heading.
  • Removed the awkward "Benchmarks and Example tests can be found…" sentence.
  • Quick-start // 1, 2, 3, 4 comment moved above the loop so it doesn't look like the output of a single Println.
  • Benchmark-shape sentence now covers Priority and Delay (both zero-alloc post recent changes).

No code changes.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (3472c91) to head (01c8a97).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #63   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          639       639           
=========================================
  Hits           639       639           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@adrianbrad adrianbrad merged commit f2490f5 into main Apr 21, 2026
10 checks passed
@adrianbrad adrianbrad deleted the docs/readme-polish branch April 21, 2026 09:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant