Уведомления

Группа в Telegram: @pythonsu

#1 Июль 8, 2014 16:23:07

agryn
От: Украина
Зарегистрирован: 2011-12-14
Сообщения: 189
Репутация: +  0  -
Профиль   Отправить e-mail  

документирование - описание невтроенных типов данных

Если моя функция возвращает например словарь, название ключей которого есть стандартным

def get_dict():
    """
    :return: some data in dict
    :rtype: dict
    """
    return {'key1': 'some string': 'key2': 123456}
То как точно описать возвращаемую структуру данных а не просто dict?

Офлайн

#2 Июль 8, 2014 18:23:17

FishHook
От:
Зарегистрирован: 2011-01-08
Сообщения: 8312
Репутация: +  568  -
Профиль   Отправить e-mail  

документирование - описание невтроенных типов данных

Если бы Вы были автором языка, как бы Вы это реализовали?



Офлайн

#3 Июль 8, 2014 21:22:53

agryn
От: Украина
Зарегистрирован: 2011-12-14
Сообщения: 189
Репутация: +  0  -
Профиль   Отправить e-mail  

документирование - описание невтроенных типов данных

FishHook
Если бы Вы были автором языка, как бы Вы это реализовали?
Если бы я был автором языка то сделал бы так как мне нравиться или так как нравиться тому кто платит деньги за развитие языка.

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

Офлайн

#4 Июль 8, 2014 21:30:20

doza_and
От:
Зарегистрирован: 2010-08-15
Сообщения: 4138
Репутация: +  252  -
Профиль   Отправить e-mail  

документирование - описание невтроенных типов данных

http://sphinx-doc.org/
не то чтобы стандарт, но близко к этому.



Офлайн

Board footer

Модераторировать

Powered by DjangoBB

Lo-Fi Version