Skip to content

docs: Improves documentation clarity and conciseness.#1

Merged
aaronstevenwhite merged 1 commit intomainfrom
docs/documentation-clarity-and-conciseness
Sep 27, 2025
Merged

docs: Improves documentation clarity and conciseness.#1
aaronstevenwhite merged 1 commit intomainfrom
docs/documentation-clarity-and-conciseness

Conversation

@aaronstevenwhite
Copy link
Collaborator

Summary

This PR improves documentation quality by making the content more concise and natural.

Key Changes

  • Removed superfluous language: Eliminated overuse of "comprehensive", "enhanced", "robust" and promotional language throughout docs and docstrings
  • Reduced documentation by 50%: Consolidated redundant examples and converted unnecessary lists to prose
  • Improved docstring clarity: Changed from formulaic "Initialize X with Y" patterns to more descriptive language

Impact

  • 505 lines removed while maintaining all essential information
  • Documentation now reads more naturally without AI-generated patterns
  • No functional changes - documentation only
  • All tests pass (1003 tests with pytest, mypy --strict, ruff check, ruff format)

Examples of Improvements

  • "Comprehensive CLI" → "Command-line interface"
  • "Enhanced VerbNet member cross-references" → "VerbNet member cross-references"
  • Converted bullet-point lists to flowing prose where appropriate
  • Removed repetitive code comments like "# Data is already loaded"

@aaronstevenwhite aaronstevenwhite merged commit e9da187 into main Sep 27, 2025
9 checks passed
@aaronstevenwhite aaronstevenwhite deleted the docs/documentation-clarity-and-conciseness branch September 27, 2025 23:53
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