Отображение документации по функциям в PyDev

Я получил 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 ответа

Решение

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

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

Привет,

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

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

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

Ура,

Fabio

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

Источник

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

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

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

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

Источник
Другие вопросы по тегам