NikomSol / MCML-Integrating-Sphere

Light transfer simulation with Monte-Carlo for Moveable Integrating Sphere method
0 stars 0 forks source link

Описание вариантов входных данных функции #1

Closed NikomSol closed 1 year ago

NikomSol commented 1 year ago

Где описать доступные моды? Т.е. условно на вход функции можно подавать такие-то варианты переменной - там и писать? Если каждый вариант переменной отправляет к новой функции - что делает новая функция писать именно в ней?

VulpesCorsac commented 1 year ago

Не совсем понял, если честно, пример проблемы в студию (:

NikomSol commented 1 year ago

В мейне пользователь пишет: cnf = {"mode": "Surface"}

И пошло оно дальше: MCML(cnf)

Который вызывает: parse_mode(cnf)

Который вызывает: parse_mode_generator(cnf)

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

Едем дальше parse_mode_generator(cnf) Вызывает условно функцию get_surface_generator, которая уже отвечает за то, что дальше будет происходить в соответствии с заданным модом.

Вопрос 1: в документации к какой функции описать возможные варианты входа? Вопрос 2: где описать то, что мы получим если зададим данный мод?

VulpesCorsac commented 1 year ago

Когда ты удёшь от словарей, то описание типа будет уже в самом enum class и дальше можно будет просто писать в аннотации - "настройки"