Отображение документации по функциям в PyDev - PullRequest
19 голосов
/ 15 декабря 2010

Я запустил Pydev и почти все работает хорошо.Однако у меня возникли некоторые проблемы со строками документов.

Скажем, например, у меня есть такая функция:

def _get_logging_statement(self):
    """Returns an easy to read string which separates items in the log file cleanly"""
    result = "\n\n#============================================="
    result += "\n#   %-80s#"(self)
    result =+ "\n\n#============================================"
    return result

Предположим, я переопределил repr для правильного форматирования этой строки какхорошо.

Когда я нахожу это в «Затмении», оно показывает мне полную строку документации, как и предполагалось.Однако полная реализация также отображается под doctsting.

Есть ли способ только отобразить строку документации?

Ответы [ 2 ]

15 голосов
/ 16 декабря 2010

Не похоже на это в настоящее время. Погуглил по этой проблеме, и лучший результат указал мне на это сообщение пользователей Pydev :

В понедельник, 3 мая 2010 года, в 5:45 утра Янош Петерс написал:

Привет,

при наведении курсора на функцию или класс я получаю всплывающую подсказку, показывающую полное определение функции / класса, а не только строка документации (как я следовало ожидать).

Это ожидаемое поведение? Я думаю, что было бы более полезным, если бы отображается содержимое строки документации.

В настоящее время ожидается. Пожалуйста, введите запрос функции, чтобы сделать показывает только строку документации.

Приветствия

Fabio

Посмотрел трекер ошибок / возможностей Pydev и не нашел этой конкретной проблемы. Возможно, вы захотите ввести его в трекер запросов функций Pydev и посмотреть, сможете ли вы получить помощь там.

0 голосов
/ 10 ноября 2017

Я отправил запрос на добавление функции в PyDev bug tracker с идентификатором 863.

В PyCharm при наведении курсора на имя метода я вижу всплывающее окно, показывающее только строка документации каждого метода, без подробностей реализации. И теги типа @param xx:, @rtype и т. Д. Анализируются правильно и отображается в удобочитаемом формате во всплывающем окне, и другой стиль, как spinx / epytext / google / plain можно настроить в настройках, чтобы распознавать все форматы.

Я хотел бы предложить то же самое в PyDev: всплывающее окно, которое показывает строка документа с проанализированными тегами, без подробностей реализации, и если как javadoc, можно использовать <code>some code, чтобы лучше отобразить его, как в HTML.

Рассмотрите возможность голосования до этого билета, если вы тоже этого хотите. (И, может быть, тоже проголосует здесь)

...