Skip to content

docs: fix typo and add missing docstrings#7

Open
harshalDharpure wants to merge 1 commit intoRedHenLab:mainfrom
harshalDharpure:docs/fix-typo-and-add-docstrings
Open

docs: fix typo and add missing docstrings#7
harshalDharpure wants to merge 1 commit intoRedHenLab:mainfrom
harshalDharpure:docs/fix-typo-and-add-docstrings

Conversation

@harshalDharpure
Copy link
Copy Markdown

Documentation and Typo Fixes

This PR improves code documentation and fixes a minor typo.

Changes:

  • Fixed typo "secoond" → "second" in english/vtt_auto_to_conll-u.py
  • Added comprehensive docstrings to 4 functions in farsi/time-frame.py:
    • time_to_centiseconds() - documents time format conversion
    • convert_timeframe() - documents timestamp distribution logic
    • parse_vtt() - documents VTT file parsing
    • main() - documents main processing workflow

Benefits:

  • Improved code maintainability
  • Better developer experience
  • Follows Python documentation standards

- Fix typo 'secoond' -> 'second' in vtt_auto_to_conll-u.py
- Add comprehensive docstrings to time_to_centiseconds, convert_timeframe, parse_vtt, and main functions in time-frame.py

This improves code documentation and maintainability.

Co-authored-by: Cursor <cursoragent@cursor.com>
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