RenderAlien / RenderAlien/thermograms
Написание базовой документации по имеющемуся функционалу
Open
@RenderAlien is already working on this.
Since Oct 24, 2025.
documentation
- Dominant language
- Jupyter Notebook
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Думаю надо задокументировать чуть более подробно уже имеющийся функционал:
1. Поддерживаемые форматы
Расписать списки - какие форматы файлов, данных поддерживаются, есть ли какие-то особенности при использовании тех или иных форматов, что рекомендуется, что нет.
2. Методы класса Timage
Расписать полный список всех имеющихся методов класса Timage. Для каждого написать:
- назначение,
- список аргументов, для каждого аргумента назначение, допустимые типы и диапазоны значений
- что возвращает
- особенности при наличии
3. Практические примеры использования со скриншотами результатов
Всё это можно добавить в README.md
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.