Skip to content

fix readme - #2

Merged
kazeburo merged 1 commit into
mainfrom
fix/readme
Sep 21, 2026
Merged

kazeburo merged 1 commit into
mainfrom
fix/readme

Conversation

@kazeburo

@kazeburo kazeburo commented Sep 21, 2026 •

Copy link
Copy Markdown
Member

PR Type

Documentation


Description

  • Fixes README line-ending feature formatting

Diagram Walkthrough

flowchart LR
  README["README.md"] -- "Corrects feature list formatting" --> Documentation["Updated documentation"]
Loading

File Walkthrough

Relevant files
Documentation
README.md
Correct line-ending feature documentation                               

README.md

  • Removes malformed backtick formatting
  • Clarifies Windows-style line ending trimming
+1/-2     

@github-actions

Copy link
Copy Markdown
Contributor

Benchmark Comparison

Base: main
PR: fix/readme

BenchmarkScan results
goos: linux
goarch: amd64
pkg: github.com/monitoring-forge/linebuf
cpu: AMD EPYC 7763 64-Core Processor                
               │ base-bench.txt │            pr-bench.txt            │
               │     sec/op     │   sec/op     vs base               │
Scan_bufio-4       163.7µ ± 11%   158.8µ ± 4%       ~ (p=0.190 n=10)
Scan_linebuf-4     126.2µ ±  5%   126.0µ ± 2%       ~ (p=0.280 n=10)
Scan_iter-4        138.2µ ±  1%   138.2µ ± 0%       ~ (p=0.869 n=10)
geomean            141.9µ         140.3µ       -1.08%

               │ base-bench.txt │             pr-bench.txt              │
               │      B/op      │     B/op      vs base                 │
Scan_bufio-4       4.000Ki ± 0%   4.000Ki ± 0%       ~ (p=1.000 n=10) ¹
Scan_linebuf-4     4.062Ki ± 0%   4.062Ki ± 0%       ~ (p=1.000 n=10) ¹
Scan_iter-4        4.078Ki ± 0%   4.078Ki ± 0%       ~ (p=1.000 n=10) ¹
geomean            4.047Ki        4.047Ki       +0.00%
¹ all samples are equal

               │ base-bench.txt │            pr-bench.txt             │
               │   allocs/op    │ allocs/op   vs base                 │
Scan_bufio-4         1.000 ± 0%   1.000 ± 0%       ~ (p=1.000 n=10) ¹
Scan_linebuf-4       2.000 ± 0%   2.000 ± 0%       ~ (p=1.000 n=10) ¹
Scan_iter-4          3.000 ± 0%   3.000 ± 0%       ~ (p=1.000 n=10) ¹
geomean              1.817        1.817       +0.00%
¹ all samples are equal

@github-actions

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No major issues detected

@github-actions

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

No code suggestions found for the PR.

@kazeburo
kazeburo merged commit 0f274fd into main Sep 21, 2026
3 checks passed
@kazeburo
kazeburo deleted the fix/readme branch September 21, 2026 08:02
@github-actions github-actions Bot mentioned this pull request Sep 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant