Skip to content

Performance Tips Reference Undocumented and Unsupported FeaturesΒ #4

@araray

Description

@araray

πŸ“š Documentation Bug

Summary

The Performance Tips section lists options and strategies that are either not implemented or misleading:


❌ Issues Identified

  • --chunk-size 64 is valid, but its impact on performance isn't documented or benchmarked.
  • MmapBytes feature is mentioned but doesn't exist in code or flags (despite memmap2 being a dependency).
  • Suggestion to β€œchain operations to minimize I/O” is invalid as chaining is not currently supported (see [Chaining Issue](https://github.com/araray/binfiddle/issues/XX)).

βœ… Suggested Fixes

  • Clarify that chunk size can affect display/output granularity, not I/O throughput (unless benchmarked).
  • Either implement or remove reference to MmapBytes.
  • Update chaining suggestion once --chain feature is available or remove it in the meantime.

πŸ“¦ Environment

  • Version: binfiddle 0.3.0
  • Platform: All

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentation

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions