-
Notifications
You must be signed in to change notification settings - Fork 65
docs: update README #300
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
docs: update README #300
Conversation
Summary of ChangesHello @e06084, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the readability and presentation of the project's documentation across multiple languages. It introduces intentional trailing spaces within the English, Japanese, and Chinese README files to control line breaks in their rendered Markdown output. To support this formatting, the pre-commit configuration has been updated to prevent automated tools from removing these specific trailing spaces from the README files. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this 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 updates the formatting in the README.md, README_ja.md, and README_zh-CN.md files by adding trailing spaces to create hard line breaks for better readability. To accommodate this, the trailing-whitespace pre-commit hook is disabled for these files. My review suggests an alternative approach for improved maintainability. Instead of using invisible trailing spaces, I recommend using a visible trailing backslash (\) for hard line breaks. This is a more robust method supported by GitHub Flavored Markdown and less prone to accidental removal by editors. Adopting this suggestion would also allow for the re-enabling of the trailing-whitespace hook, contributing to better code hygiene across the repository. I've provided specific suggestions in the README files to illustrate this.
| rev: v5.0.0 | ||
| hooks: | ||
| - id: trailing-whitespace | ||
| exclude: '^README.*\.md$' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This exclusion for trailing-whitespace was added to support hard line breaks in README files using trailing spaces. If the suggestion to use trailing backslashes (\) in the README files is adopted, this exclusion line is no longer necessary and should be removed. This would improve repository hygiene by ensuring no unintended trailing whitespace is committed.
| **Diverse Data Sources** - Connect to where your data lives | ||
| ✅ **Local Files**: JSONL, CSV, TXT, Parquet | ||
| ✅ **SQL Databases**: PostgreSQL, MySQL, SQLite, Oracle, SQL Server (with stream processing) | ||
| ✅ **Cloud Storage**: S3 and S3-compatible storage |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better maintainability, consider using a trailing backslash (\) for hard line breaks instead of two spaces. Trailing spaces are invisible and can be easily stripped by editors, while a backslash is explicit and visible. This change would also allow you to re-enable the trailing-whitespace pre-commit hook for these files.
| **Diverse Data Sources** - Connect to where your data lives | |
| ✅ **Local Files**: JSONL, CSV, TXT, Parquet | |
| ✅ **SQL Databases**: PostgreSQL, MySQL, SQLite, Oracle, SQL Server (with stream processing) | |
| ✅ **Cloud Storage**: S3 and S3-compatible storage | |
| **Diverse Data Sources** - Connect to where your data lives\ | |
| ✅ **Local Files**: JSONL, CSV, TXT, Parquet\ | |
| ✅ **SQL Databases**: PostgreSQL, MySQL, SQLite, Oracle, SQL Server (with stream processing)\ | |
| ✅ **Cloud Storage**: S3 and S3-compatible storage\ |
| **多様なデータソース** - データがある場所に接続 | ||
| ✅ **ローカルファイル**:JSONL、CSV、TXT、Parquet | ||
| ✅ **SQL データベース**:PostgreSQL、MySQL、SQLite、Oracle、SQL Server(ストリーミング処理対応) | ||
| ✅ **クラウドストレージ**:S3 および S3 互換ストレージ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better maintainability, consider using a trailing backslash (\) for hard line breaks instead of two spaces. Trailing spaces are invisible and can be easily stripped by editors, while a backslash is explicit and visible. This change would also allow you to re-enable the trailing-whitespace pre-commit hook for these files.
| **多様なデータソース** - データがある場所に接続 | |
| ✅ **ローカルファイル**:JSONL、CSV、TXT、Parquet | |
| ✅ **SQL データベース**:PostgreSQL、MySQL、SQLite、Oracle、SQL Server(ストリーミング処理対応) | |
| ✅ **クラウドストレージ**:S3 および S3 互換ストレージ | |
| **多様なデータソース** - データがある場所に接続\ | |
| ✅ **ローカルファイル**:JSONL、CSV、TXT、Parquet\ | |
| ✅ **SQL データベース**:PostgreSQL、MySQL、SQLite、Oracle、SQL Server(ストリーミング処理対応)\ | |
| ✅ **クラウドストレージ**:S3 および S3 互換ストレージ\ |
| **多样化数据源** - 连接到你的数据所在之处 | ||
| ✅ **本地文件**:JSONL、CSV、TXT、Parquet | ||
| ✅ **SQL 数据库**:PostgreSQL、MySQL、SQLite、Oracle、SQL Server(支持流式处理) | ||
| ✅ **云存储**:S3 和 S3 兼容存储 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better maintainability, consider using a trailing backslash (\) for hard line breaks instead of two spaces. Trailing spaces are invisible and can be easily stripped by editors, while a backslash is explicit and visible. This change would also allow you to re-enable the trailing-whitespace pre-commit hook for these files.
| **多样化数据源** - 连接到你的数据所在之处 | |
| ✅ **本地文件**:JSONL、CSV、TXT、Parquet | |
| ✅ **SQL 数据库**:PostgreSQL、MySQL、SQLite、Oracle、SQL Server(支持流式处理) | |
| ✅ **云存储**:S3 和 S3 兼容存储 | |
| **多样化数据源** - 连接到你的数据所在之处\ | |
| ✅ **本地文件**:JSONL、CSV、TXT、Parquet\ | |
| ✅ **SQL 数据库**:PostgreSQL、MySQL、SQLite、Oracle、SQL Server(支持流式处理)\ | |
| ✅ **云存储**:S3 和 S3 兼容存储\ |
* docs: update README * x
No description provided.