Глава 3: readTheDocs
Когда-нибудь слышали о документации? А считали ли, что шерудить документацию очень долго, муторно, сложно, в то время как загуглить в Интернете или спросить товарища по развитию решение проблемы намного проще, быстрее, эффективнее?
Не переживай, в этом нет ничего осуждающего, да и не обращай внимания на этих гигачадов, которые себе Интернет протягивают лишь для того, чтобы дока грузилась.
Но все же, разве не очевидно , что загуглить или спросить у ИИ намного лучше? Ведь документация может быть плохо написана, в ней невозможно ориентироваться и вообще её писали на коленке.
Ну такое возможно, да, но автора документации не стоит осуждать за это, он всё-таки хотя бы сделал документацию, чтобы вы смогли воспользоваться его трудом, который он вообще мог бы и не отдавать вам на растерзания. Но да, хвалить за такое тоже не нужно.
Но тяжело-читаемая документация может привести к страшным для психики пользователя последствиям.
Однажды я пользовался одной библиотекой, где была одна очень важная фича, необходимая в моем проекте. Как бы я ее не имплементировал, я сталкивался с тем, что фича работает не так, как я хочу. Был дурацкий баг, который все портил. Сколько часов было потрачено на поиск решения, создания костылей, включается мозга и все это, конечно же, было тщетно.
Но в один прекрасный момент я решил ещё раз посмотреть, какие аргументы можно закинуть в хук, который я использовал, и... О боги, я обнаружил в самом конце страницы с документацией тот аргумент, который мне нужен был. По всем канонам, конечно же, возможность внедрения этого аргумента было написано мелким шрифтом.
Но я не сразу понял, что это тот аргумент, который мне нужен. Знаешь, как я смог догадаться до того, что это то, что мне нужно? Я начал ЭКСПЕРИМЕНТИРОВАТЬ с данным аргументом, впихивал в него разные значения. Спустя 10-ти таких попыток я полностью осознал силу этого хука, этого аргумента, и распрощался с багом навсегда.
Поэтому не бойтесь никогда экспериментировать, и если вдруг не найдете ответ в документации, то попробуйте просмотреть ее ещё раз и проверить, как работает та или иная фича, на которую упал ваш глаз.
Мысль: не бойтесь экспериментировать с фичой из документации, даже если эта документация скупа на объяснения. Быть может, то, что вам нужно находиться у Вас под носом...
