Skip to content

Documentation Improvements#968

Merged
michelebastione merged 14 commits into
mini-software:masterfrom
michelebastione:documentation-improvements
May 30, 2026
Merged

Documentation Improvements#968
michelebastione merged 14 commits into
mini-software:masterfrom
michelebastione:documentation-improvements

Conversation

@michelebastione
Copy link
Copy Markdown
Collaborator

@michelebastione michelebastione commented May 30, 2026

  • Added proper documentation to OpenXmlImporter, OpenXmlExporter, CsvImporter, CsvExporter, and OpenXmlTemplater
  • Added leaveOpen parameter to methods that take a stream as an input for both OpenXmlImporter and CsvImporter to configure whether it should be closed after the operation is completed
  • Renamed useHeaderRow parameter to hasHeaderRow in all API methods to clarify its usage
  • Removed unused configuration parameter from some OpenXmlImporter methods
  • Other minor changes

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread src/MiniExcel.OpenXml/Utils/SharedStringsDiskCache.cs Outdated
Comment thread src/MiniExcel.Csv/Api/CsvImporter.cs
Comment thread src/MiniExcel.Csv/Api/CsvImporter.cs
Comment thread src/MiniExcel.OpenXml/Api/OpenXmlImporter.cs
Comment thread src/MiniExcel.OpenXml/Api/OpenXmlImporter.cs
Comment thread src/MiniExcel.Core/MiniExcelDataReader.cs
Comment thread src/MiniExcel.Core/MiniExcelDataReader.cs Outdated
@michelebastione michelebastione merged commit 47a7752 into mini-software:master May 30, 2026
3 checks passed
@michelebastione michelebastione deleted the documentation-improvements branch May 30, 2026 18:49
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