Вопрос по документации к проекту. В связи с неидеальным качеством своего

английского опасаюсь, что могу допустить неточности, особенно в полноценном техническом описании внутренней реализации.
README осилю - там проблем, думаю, всё-таки не возникнет :)
Как правильно поступить?
Вариант "пиши на русском" несколько напрягает
Совет подтянуть язык хорош, но, увы, не очень подходит как решение "здесь и сейчас"

grammarly + reverso context + google translate - дерзай ✍️

не совсем понятно, что хотите услышать в контексте С++ чата. К doxygen я про такие плагины не слышал (если у вас дока к проекту в доксигене, во что я очень слабо верю). А так - можно пробовать в CI натравливать какие-нибудь speel/grammar checkers и фейлить PR, если нашли проблему (сразу готовьтесь к проблемам подбора софта, false positives и тому подобному) + наверняка свою разметку местами делать придется + ещё чуток подкодить. Можно пробовать делать тоже самое чуть раньше на тачке разраба с помощью тех же спеллчекеров и прекоммит хуков. Можно разрабам в IDE поставить спеллчекеры какие-нибудь

Еще dictionary.cambridge.org

Насколько я знаю у Дмитрия дока на доксиджене

лучше так, чем никак :) но сути дела сильно не меняет

Очевидный вопрос – что из себя представляет проект и так ли важны последствия возможных неточностей? Это, пожалуй, риторический вопрос, на который я предлагаю ответить для себя

Проект — супер крутая либа

Ох. Уже для обработчика исключений я готов не поскупиться на несколько страниц и даже диаграммы😅

В супер-крутой либе код настолько крут, что он самодокументируем на 100% :) вот и решили проблему

@DymOK расходимся

я сразу тебе накину - если они у тебя не генерятся из кода (я про диаграммы и так далее), то как ты контролируешь их актуальность?

Там наверное диаграммы про принцип работы, который не сильно со временем изменится

конкретно тут - про обработку исключений. Это имхо вполне себе частоизменяющаяся вещь (по крайней мере у меня всегда так было)

Речь шла не о UML-ках иерархии классов всё-таки Против doxygen'а я абсолютно ничего не имею и его хотелось бы юзать

"Обработку" в смысле "try/catch своими руками" :)

Человек пишет аналог STL для разработки около ядра винды

я не понимаю, про какие диаграммы тогда речь. я запутался

ааааа, ну это немного другая дока. теперь я понял)

a можно GitHub линк, если это опенсорс?

@DymOK народ просит

Ссылка сразу на ветку с readme более-менее нормальным - каюсь, он буквально сегодня доехал( https://github.com/DymOK93/KTL/tree/feature_extended_readme

Спасибо, можешь начать с examples и документация не понадобится ))

FWIW, Виктор Зверович в своей доке https://github.com/fmtlib/fmt doxygen экспортировал в sphinx с темой readthedocs при помощи плагина breathe.

а в качестве референса какой STL брался?

Солянка, если честно MS, libc++, abseil, сторонние решения

Оно ж у же есть какое-то. KTL вроде называется

оно? https://github.com/MeeSong/KTL

Да

Есть отличия?

Оно без CMake, не Standard-Conforming, нет CRT, исключений, корутин и многого другого :)

Зато название уже застолбил)

Ну значит сделать форк, снести всё, залить своё, и прислать пулл-реквест

Исключения в йадре? Это как?

Это так :)

Вряд ли автор ответит, хотя в общем случае вопрос нейминга интересен

Застолбил, не застолбил, выглядит хуже: 1. Не вижу документации и нормального readme 2. Там уб видно невооружённым взглядом: используются идентификаторы _L* — наверное ничего страшного, но неприятно 3. Нет CMake

А такое вообще возможно?

Чтобы диаграммы из кода генерировались?

Угу...

Ну конечно Doxygen же это как-то делает)

большинство используют graphviz, в том числе Doxygen