Skip to content

Fix documentation consistency and add missing S3FS references#635

Merged
laughingman7743 merged 1 commit intomasterfrom
docs/fix-documentation-consistency
Jan 3, 2026
Merged

Fix documentation consistency and add missing S3FS references#635
laughingman7743 merged 1 commit intomasterfrom
docs/fix-documentation-consistency

Conversation

@laughingman7743
Copy link
Member

Summary

  • Add missing S3FS cursor references across documentation
  • Standardize heading capitalization to sentence case
  • Improve documentation organization and fix minor issues

Changes

S3FS references added

  • cursor.rst: Added S3FSCursor and AsyncS3FSCursor sections
  • sqlalchemy.rst: Added S3FS dialect to dialect table and callback support list
  • introduction.rst: Added S3FS to cursor types list

Documentation organization

  • index.rst: Reordered toctree (cursor before sqlalchemy)
  • api.rst: Reordered toctree and sections for better logical flow

Heading capitalization (sentence case)

  • api.rst: API Reference → API reference, Quick Reference → Quick reference, etc.
  • s3fs.rst: Type Conversion → Type conversion, CSV Reader Options → CSV reader options
  • sqlalchemy.rst: All section headings standardized
  • usage.rst: Query Execution Callback → Query execution callback

Minor fixes

  • Removed duplicate "API Reference" section from cursor.rst
  • Fixed trailing whitespace in several files

🤖 Generated with Claude Code

- Add S3FSCursor and AsyncS3FSCursor to cursor.rst
- Add S3FS dialect to SQLAlchemy dialect table
- Add S3FS cursor to callback support list
- Add S3FS to cursor types in introduction
- Reorder toctree entries for better organization
- Standardize heading capitalization to sentence case
- Fix trailing whitespace

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@laughingman7743 laughingman7743 marked this pull request as ready for review January 3, 2026 02:06
@laughingman7743 laughingman7743 merged commit 81cf7d6 into master Jan 3, 2026
5 checks passed
@laughingman7743 laughingman7743 deleted the docs/fix-documentation-consistency branch January 3, 2026 02:06
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