Improve API documentation

[wiktorpyk]

Hey.
Is there a library version?

[palemieux]

What is a library version?

[wiktorpyk]

Is there a way to import ttconv into a python project? I didn't find any info about it

[palemieux]

Is there a way to import ttconv into a python project? I didn't find any info about it

Yes! See https://github.com/sandflow/imscHRM for an example.

https://github.com/sandflow/imscHRM/blob/a17e46fbbaf55b957d787a4d080a5129575501b4/Pipfile#L10
https://github.com/sandflow/imscHRM/blob/a17e46fbbaf55b957d787a4d080a5129575501b4/src/main/python/imschrm/hrm.py#L38

[wiktorpyk]

Is there any documentation for this? If not, are there any plans for writing any?

[palemieux]

There is:

• high-level documentation at https://github.com/sandflow/ttconv/tree/master/doc
• inline documentation, e.g.,

  ttconv/src/main/python/ttconv/isd.py

  Line 137 in 1705ecc

  '''Adds a region to the ISD, replacing any existing region with the same `id`.'''

• many unit test to get inspired from at https://github.com/sandflow/ttconv/tree/master/src/test/python

Are you looking for something specific?

Documentation can always be improved.