pythonz icon indicating copy to clipboard operation
pythonz copied to clipboard

«Живой» поиск и упрощение навигации в Справочнике

Open WebsterQR opened this issue 4 years ago • 1 comments

На мой взгляд, основной раздел который посещают люди это справочник. Мне кажется, что данные там стоило бы "причесать":

  • Мне кажется, что человеку не сильно знакомому с Python будет непросто найти информацию о нужной ему функции. Я бы предложил сделать "живой" поиск на главной странице справочника, который будет предлагать функции которые могут интересовать пользователя. К примеру, пользователь набирает в строке "i", сайт ему предлагает input(), int(), iterable() и т.д., при введенной второй букве n в выборе останутся только int() и input() и т.д. Если я не ошибаюсь, такое может быть реализовано в сочетании JS и фильтрации в Django
  • Что касается визуального восприятия лично мне бросается в глаза то, что в первую очередь в том же справочнике на первом месте идет раздел дополнительно (хотя интуитивно самые важные разделы это синтаксис и стандартная библиотека), а также то, что слова режутся многоточием в описании (которым не нашлос…, по стандартной библиот…)

WebsterQR avatar Oct 07 '21 23:10 WebsterQR

Спасибо за идеи.

  1. Вариант поиска с подсказами (он же «саджест» — suggest) хорош. Перекликается с #29 2.1. Над необходимостью упорядочивания можно подумать (сейчас она алфавитная). 2.2. Краткие описания также можно не резать. Такое усечение осталось в тех времён, когда блок «В этом разделе» (в котором сейчас выводятся имена методов/функций) использовал это же табличное представление, а даже краткие описания функций могут быть довольно длинными.

Вообще, улучшение навигации по разделу справки напрашивается уже давно.

idlesign avatar Oct 08 '21 05:10 idlesign