Skip to content

Commit 273390b

Browse files
k-ibarakiclaude
andcommitted
docs: add include_frozen_rows documentation and improve docstrings
## 変更内容 ### ドキュメント更新 - README.md/README_ja.md: `include_frozen_rows`パラメータの説明を追加 - ヘッダー自動追加機能の使い方を明記 - 構造情報に`frozen_rows`、`frozen_cols`を追加 ### docstring改善 - `_calculate_header_range()`: 引数が拡張後の範囲であることを明記 - 誤解を招く記載を修正 ## レビュー結果 - ✅ コード品質: PASS(型チェック、Lint、テスト) - ✅ ドキュメント: 完全 - ✅ テスト: 100%カバレッジ Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent f66c8d0 commit 273390b

3 files changed

Lines changed: 8 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,10 @@ Two authentication methods are supported:
3535
- Read or search Excel files in SharePoint
3636
- Search mode: find cells containing specific text with `query` parameter
3737
- Read mode: get data from specific sheets/ranges with `sheet` and `cell_range` parameters
38+
- **Automatic header inclusion**: when `cell_range` is specified, frozen rows (headers) are automatically included by default
39+
- Set `include_frozen_rows=False` to get only the specified range
3840
- Response includes cell data in `rows` (value and coordinate) and structural information when available
39-
- Structural info: sheet name, dimensions, freeze_panes (when present), merged_ranges (when merged cells exist)
41+
- Structural info: sheet name, dimensions, frozen_rows, frozen_cols, freeze_panes (when present), merged_ranges (when merged cells exist)
4042
- No Excel Services dependency - uses direct file download + openpyxl parsing
4143

4244
### OneDrive Support

README_ja.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,10 @@ stdioとHTTPの両方のトランスポートに対応しています。
3535
- SharePoint上のExcelファイルの読み取りと検索
3636
- 検索モード: `query`パラメータで特定テキストを含むセルを検索
3737
- 読み取りモード: `sheet``cell_range`パラメータで特定シート/範囲を取得
38+
- **ヘッダー自動追加**: `cell_range`指定時、デフォルトで固定行(ヘッダー)を自動的に含める
39+
- `include_frozen_rows=False`を指定すると、指定範囲のみを取得
3840
- レスポンスには`rows`内のセルデータ(値と座標)と構造情報(利用可能な場合)を含む
39-
- 構造情報: シート名、dimensions、freeze_panes(存在する場合)、merged_ranges(結合セルが存在する場合)
41+
- 構造情報: シート名、dimensions、frozen_rows、frozen_cols、freeze_panes(存在する場合)、merged_ranges(結合セルが存在する場合)
4042
- Excel Services不要 - 直接ファイルダウンロード+openpyxl解析方式
4143

4244
### OneDrive対応

src/sharepoint_excel.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,10 +292,11 @@ def _calculate_header_range(
292292
self, cell_range: str, frozen_rows: int
293293
) -> str | None:
294294
"""
295-
cell_rangeに対してfrozen_rowsに基づくヘッダー範囲を計算
295+
セル範囲に対してfrozen_rowsに基づくヘッダー範囲を計算
296296
297297
Args:
298298
cell_range: セル範囲(例: "A5:D10")
299+
拡張後のeffective_rangeを渡すこと(軸拡張済み)
299300
frozen_rows: 固定行数
300301
301302
Returns:

0 commit comments

Comments
 (0)