Skip to content

Enhancement: Add Type Hints and Type Checks for Better Developer Experience #218

@anuragsinghbhandari

Description

@anuragsinghbhandari

Hi Sumy maintainers 👋,

First off, thank you for maintaining this project it's been super helpful for building quick and efficient extractive summarization tools.

I’d like to suggest adding type hints and possibly integrating type checking across the codebase.

💡 Why This Matters

  • Type hints improve code readability and documentation.
  • Type checking helps catch bugs early during development.
  • It makes the project more developer-friendly and encourages community contributions from those using modern Python tooling.

🔧 Example

def summarize(text: str, sentence_count: int = 3) -> List[str]:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions