Отображение функциональной документации в Pydev

Question

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

Допустим, например, у меня есть функция, такая как следующая:

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

Предположим, что я также переопределял PERP, чтобы форматировать эту строку правильно.

Когда я нахожусь на это в Eclipse, это показывает мне полный Docstring, как и предполагалось. Тем не менее, полная реализация также отображается ниже Doctsting.

Есть ли способ Только Показать Docstring?

Answer 1

В настоящее время не похоже на это. Погуглился по этому вопросу, и верхний результат указал мне на это Pydev-Users Post:

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

Привет,

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

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

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

Ваше здоровье,

Фабио

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

Answer 2

Я отправил запрос на функции в Pydev Bug Tracker, с ID 863.

В Pycharm, когда я нахожусь на имя метода, я вижу всплывающее окно, показывающее только DOCSTRING каждого метода, без деталей реализации. И теги любят @param xx:, @rtype, и т. д., проанализируются правильно и показаны в читаемом формате во всплывающем окне, и в различных стилях, таких как Spinx/Epytext/Google/Plain, можно настроить в настройках, чтобы он мог распознать все форматы.

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

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