Skip to content
This repository was archived by the owner on Mar 28, 2026. It is now read-only.

Add comprehensive Rust documentation for docs.rs#111

Merged
mosuka merged 1 commit into
mainfrom
lindera
Oct 27, 2025
Merged

Add comprehensive Rust documentation for docs.rs#111
mosuka merged 1 commit into
mainfrom
lindera

Conversation

@mosuka

@mosuka mosuka commented Oct 27, 2025

Copy link
Copy Markdown
Member

This commit adds extensive documentation comments to all Rust modules
in the src/ directory to improve the docs.rs documentation quality.

Changes:

  • Add crate-level documentation to lib.rs with overview and examples
  • Document tokenizer module: TokenizerBuilder and Tokenizer classes
  • Document dictionary module: Dictionary, UserDictionary, and related functions
  • Document metadata module: Metadata and CompressionAlgorithm types
  • Document mode module: Mode enum and Penalty configuration
  • Document schema module: Schema, FieldDefinition, and FieldType
  • Document error module: LinderaError type
  • Document util module: Python-Rust conversion utilities
  • Document trainer module: model training and export functions
  • Remove unnecessary #[allow(non_snake_case)] attribute from dictionary.rs

All documentation includes:

  • Module-level descriptions and usage examples
  • Detailed function/method documentation with arguments and return values
  • Python code examples for end-user reference
  • Error handling documentation where applicable

@mosuka mosuka merged commit ae0b7a8 into main Oct 27, 2025
5 checks passed
@mosuka mosuka deleted the lindera branch October 27, 2025 07:32
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant