Documentation Improvements - #968
Merged
michelebastione merged 14 commits intoMay 30, 2026
Merged
Conversation
…enchmark projects
…nfigure if the underlying stream is closed when the reader is disposed
…, GetSheetInformations and GetColumnNames
…orter API methods
Added `leaveOpen` parameter to `GetDataReader` API methods and renamed parameter `useHeaderRow` to `hasHeaderRow` for clarifying its usage.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces several API updates, including renaming useHeaderRow to hasHeaderRow, changing CsvExporter.Export to return int instead of int[], adding a leaveOpen parameter to data readers, caching ordinals in MiniExcelDataReader, and optimizing SharedStringsDiskCache with stackalloc for .NET. Feedback from the review highlights a security risk of unbounded stackalloc in SharedStringsDiskCache that could cause a stack overflow, and notes that the leaveOpen implementation is currently broken because the underlying readers still dispose of the stream. Additionally, potential null reference issues were flagged in MiniExcelDataReader regarding GetOrdinal and the removal of null safety on Current keys.
…hat take a stream as an input
shps951023
pushed a commit
that referenced
this pull request
Aug 29, 2026
* Integrated missing documentation in the OpenXmlTemplater * Minor optimizations * Update packages suffering from security vulnerabilities in test and benchmark projects * Added leaveOpen parameter to GetDataReader API method overloads to configure if the underlying stream is closed when the reader is disposed * Removed unused configuration parameter from API methods GetSheetNames, GetSheetInformations and GetColumnNames * Renamed parameter useHeaderRow to hasHeaderRow in multiple OpenXmlImporter API methods * Added documentation to all OpenXmlImporter methods * Simplified namespaces in the fluent mapping api * Sealed CsvReader and CsvWriter classes and simplified Dispose pattern * Changed return type of API methods CsvExporter.Export from int[] to int * Added documentation for CsvExporter * Changes to CsvImporter API methods Added `leaveOpen` parameter to methods that take a stream as an input for both `OpenXmlImporter` and `CsvImporter` to configure whether the underlying stream should be closed after the operation is completed * Added documentation to CsvImporter class
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
1 participant
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.
OpenXmlImporter,OpenXmlExporter,CsvImporter,CsvExporter, andOpenXmlTemplaterleaveOpenparameter to methods that take a stream as an input for bothOpenXmlImporterandCsvImporterto configure whether it should be closed after the operation is completeduseHeaderRowparameter tohasHeaderRowin all API methods to clarify its usageconfigurationparameter from someOpenXmlImportermethods