Ребята у меня вопрос возник по dockstring. Их можно делать только

Question

Ребята у меня вопрос возник по dockstring. Их можно делать только

у класса или функции?
Я например хотел бы сделать отдельные dockstring для конкретных строк кода внутри функции, но кажется с доке они потом не отображаются.

Может кто-то знает как это можно реализовать?

#backend #programming #python #russian

0

23.08.2023

8 ответов

6 просмотров

Alex

Ты кажется путаешь докстринги и комментарии... зачем делать докстринги у "отдельных строк кода" ?

0

23.08.2023

Alex

Что значит вообще "докстринг для конкретных строк кода" и как ты представляешь это вообще должно работать?

0

23.08.2023

Pavel A Автор вопроса

Alex
Ты кажется путаешь докстринги и комментарии... зач...

Я хочу чтобы бы они попадали в документацию. К примеру def example(a, b) : ''' Это функция попадет в доку"' c =a+b "'Хочу что бы эта строчка описания тоже была а доке"'

0

23.08.2023

Alex

Pavel A
Я хочу чтобы бы они попадали в документацию. К п...

Зачем? Какой в этом смысл? Что ты вообще таким образом собрался описывать?

0

23.08.2023

Pavel A Автор вопроса

Alex
Зачем? Какой в этом смысл? Что ты вообще таким обр...

Понимаю что это скажем так, не по назначению. Но лично для меня это удобный вариант. Для внутреннего пользования, каждый новый пользователь сможет прочитать по сгенерированной доке и суть функции и что делает определенный (важный для нас) кусок кода

0

23.08.2023

Alex

Pavel A
Понимаю что это скажем так, не по назначению. Но л...

Что мешает просто перейти к исходнику из доки и прочитать комментарий к коду?

0

23.08.2023

Pavel A Автор вопроса

Alex
Что мешает просто перейти к исходнику из доки и пр...

Понял, спасибо за помощь. А вот по поводу "перейти к исходнику" . Прям сама дока имеет ссылку на исходник или я не верно понял?

0

23.08.2023