Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OutputBuilder duplicates StringBuilder bits: simplify or document #198

Open
DavidRieman opened this issue Nov 11, 2024 · 0 comments
Open

Comments

@DavidRieman
Copy link
Owner

DavidRieman commented Nov 11, 2024

We need to assess the work that was done to build up OutputBuilder's specialized string building. I feel like there had been discussion (probably on a PR or two that introduced such changes) about the why the work was done - but I don't recall if there was any hard evidence of actual performance assessment and comparison versus standard StringBuilder functionality. As such, we need to track down such evidence (if it existed) and record the documentation better, such as embedding it in significant <remarks> comment section on the OutputBuilder class itself. If there is no such evidence, we may need to do fresh performance assessment. Basically, if OutputBuilder is not significantly faster or less memory-thrashing (generating a lot less GC or something) then the potential for bugs from it being custom code may not be worth it.

TLDR: Measure to see if OutputBuilder complexity was premature optimization: If problematic or very comparable to standard StringBuilder ops, simplify the code. If good though, document those performance characteristics.

@DavidRieman DavidRieman changed the title OutputBuilder duplicates StringBuilder functionality without documenting why OutputBuilder duplicates StringBuilder bits: simplify or document Nov 11, 2024
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

No branches or pull requests

1 participant