<div dir="ltr">Hi Carol,<div><br></div><div>Thank you very much for your follow up, I'm glad to know I wasn't completely out to lunch on the day.</div><div><br></div><div>I'm "watching" the issue page. I'll be sure to search the issue system if I come across problems in the future.</div><div><br></div><div>Cheers,</div><div>QM</div></div><div class="gmail_extra"><br><div class="gmail_quote">On Wed, Jan 31, 2018 at 3:59 PM, Carol Willing <span dir="ltr"><<a href="mailto:willingc@willingconsulting.com" target="_blank">willingc@willingconsulting.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div style="word-wrap:break-word;line-break:after-white-space">Hi Quantum Mechanic,<div><br></div><div>Web Search</div><div>-------------</div><div>I went back and checked a Google search and a Duck Duck Go search on "pylint".</div><div><br></div><div>- On Duck Duck Go, <a href="https://www.pylint.org" target="_blank">https://www.pylint.org</a> and <a href="https://pylint.readthedocs.io/en/latest/" target="_blank">htt<wbr>ps://pylint.readthedocs.io/en/<wbr>latest/</a> are the first two hits.</div><div>- On Google, <a href="https://www.pylint.org" target="_blank">https://www.pylint.org</a> and <span style="color:rgb(0,102,33);font-family:Roboto,arial,sans-serif;font-size:14px;white-space:nowrap;background-color:rgb(255,255,255)"><a href="https://pypi.python.org/pypi/pylint" target="_blank">htt<wbr>ps://pypi.python.org/pypi/<wbr>pylint</a> </span>are the first two hits.</div><div><br></div><div>For a "pylint pylintrc" search:</div><div><br></div><div>- On Duck Duck Go, the website and v2.0 ReadTheDocs page are in the top four hits.</div><div>- On Google, the v1.6.5 ReadThe Docs page and the GitHub repo are in the top two hits.</div><div><br></div><div>I'm not an SEO person but someone else may have a suggestion on how to improve the hit rate for v2.0 ReadTheDocs on Google. </div><div><br></div><div>ReadTheDocs Search</div><div>-----------------------</div><div>When I try searching on "pylintrc" from the search box, I do receive 6 hits. Unfortunately, each of those when clicked redirect to the docs home page. Searching for "init-hook", I see the same behavior. This is a bug/configuration error in Sphinx setup or the theme of some sort.</div><div><br></div><div>There is an open issue on the  GitHub repo: <a href="https://github.com/PyCQA/pylint/issues/1600" target="_blank">https://github.com/<wbr>PyCQA/pylint/issues/1600</a></div><div><br></div><div>Next actions</div><div>--------------</div><div><br></div><div>I've added this summary to the open issue: <a href="https://github.com/PyCQA/pylint/issues/1600#issuecomment-361977477" target="_blank">https://github.com/<wbr>PyCQA/pylint/issues/1600#<wbr>issuecomment-361977477</a></div><div><br></div><div>Perhaps labeling this doc issue as Help Wanted as well would be useful.</div><div><br></div><div>Regards,</div><div><br></div><div>Carol</div><div><div><br><blockquote type="cite"><div><div class="h5"><div>On Jan 30, 2018, at 8:46 AM, Quantum Mechanic <<a href="mailto:quantum.mechanic.1964@gmail.com" target="_blank">quantum.mechanic.1964@gmail.<wbr>com</a>> wrote:</div><br class="m_-4964139221549567676Apple-interchange-newline"></div></div><div><div><div class="h5"><div dir="ltr" style="font-family:Verdana;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px">Hi,<div><br></div><div>I'm sorry I riled everyone up. My apologies. </div><div><br></div><div>=== Trying to reproduce ===</div><div>Getting back to this today, I'm not sent to<span class="m_-4964139221549567676Apple-converted-space"> </span><a href="http://readthedocs.org/" target="_blank">readthedocs.org</a>. I'll chalk that up to the interwebz demons fiddling around (could be anywhere between my $work, Google, and your end, including various intermediaries).</div><div><br></div><div>Now, back to the next problem. There doesn't seem to be any documentation on the fields in .pylintrc. I'm specifically looking for<span class="m_-4964139221549567676Apple-converted-space"> </span><font face="monospace, monospace">init-hook</font><span class="m_-4964139221549567676Apple-converted-space"> </span>help. </div><div><br></div><div>I can't find anything of substance in the html docs, so I download the PDF and search for "init-hook". There are 6 hits, most only mentions.</div><div><br></div><div>Finally, it occurs to me (from the nature of the change summaries in the PDF) that this is probably a command line argument. Low and behold,<span class="m_-4964139221549567676Apple-converted-space"> </span><font face="monospace, monospace">pylint --help<span class="m_-4964139221549567676Apple-converted-space"> </span></font><font face="arial, helvetica, sans-serif">has a blurb. (As an aside, I'm wondering how to format this well for command line, due to the significant whitespace feature, but that's a problem for another day.)</font></div><div><br></div><div><font face="arial, helvetica, sans-serif">=== Problem 1 ===</font></div><div><font face="arial, helvetica, sans-serif">Search not helpful</font></div><div><font face="arial, helvetica, sans-serif">===============</font></div><div><font face="arial, helvetica, sans-serif"><br></font></div><div><font face="arial, helvetica, sans-serif">For me, the web docs are not that helpful for searching, as it doesn't get me any closer. Take this screenshot of a search for init-hook:</font></div><div><font face="arial, helvetica, sans-serif"><br></font></div><div><font face="arial, helvetica, sans-serif">The first link goes to <a href="http://docs.pylint.org/en/latest/user_guide/run.html?highlight=init-hook" target="_blank">http://docs.pylint.org/en/<wbr>latest/user_guide/run.html?<wbr>highlight=init-hook</a>, which looks like this:</font></div><div><br></div><div>...which I had before.</div><div><br></div><div>=== Problem 2 ===</div><div>Command line help not online</div><div>===============</div><div><br></div><div>The command line help does not exist online or in the PDF in except in brief, as far as I can see. Perhaps this is intentional? (It makes it harder to post Stack Exchange answers, but that's SEP.)</div><div><br></div><div>=== Problem 3 ===<br></div><div>How to include multiline code in .pylintrc file in the init-hook section.</div><div>===============</div><div><br></div><div>This doesn't seem to be covered anywhere in the docs, but is an obvious use case.</div><div><br></div><div><br></div></div><div class="gmail_extra" style="font-family:Verdana;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px"><br><div class="gmail_quote">On Fri, Jan 26, 2018 at 12:05 PM, Quantum Mechanic<span class="m_-4964139221549567676Apple-converted-space"> </span><span dir="ltr"><<a href="mailto:quantum.mechanic.1964@gmail.com" target="_blank">quantum.mechanic.<wbr>1964@gmail.com</a>></span>wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"><div dir="ltr">Googling for "pylint pylintrc" gives me the first hit as <a href="https://docs.pylint.org/en/1.6.0/run.html" target="_blank">https://docs.pylint.org/en/<wbr>1.6.0/run.html</a>.<div><br></div><div>This lands me on <a href="https://docs.pylint.org/en/1.6.0/run.html" target="_blank">https://docs.pylint.org/en/<wbr>1.6.0/run.html</a>, asking me to login. I have a login, and clicking "Login" sends me to <a href="https://readthedocs.org/dashboard/" target="_blank">https://readthedocs.org/das<wbr>hboard/</a>, spoiling the google search.</div><div><br></div><div>In fact, searching on google only shows me that something might be there. I have to search *again* on ReadTheDocs, which isn't friendly at all.</div><div><br></div><div>Poking around until I find a search box at <a href="https://pylint.readthedocs.io/en/latest/" target="_blank">https://pylint.readthedocs.<wbr>io/en/latest/</a>, I type in "pylintrc", which returns the *same bloody page* (OK, yes, it has this helpful bit: <a href="https://pylint.readthedocs.io/en/latest/?highlight=pylintrc" target="_blank">https://pylint.readthedoc<wbr>s.io/en/latest/?highlight=<wbr>pylintrc</a>, which does exactly...nothing.)</div><div><br></div><div>So I'm stuck trolling around in the full docs there. Instead, I should just pull down the source code, and do my own<span class="m_-4964139221549567676Apple-converted-space"> </span><font face="monospace, monospace">grep -r.</font></div><div><font face="monospace, monospace"><br></font></div><div><font face="arial, helvetica, sans-serif">I feel like I've been violated.</font><span class="m_-4964139221549567676HOEnZb"><font color="#888888"><br clear="all"><div><br></div>--<span class="m_-4964139221549567676Apple-converted-space"> </span><br><div class="m_-4964139221549567676m_3855677723374771993gmail_signature">-QM<br>Quantum Mechanics: The dreams stuff is made of</div></font></span></div></div></blockquote></div><br><br clear="all"><div><br></div>--<span class="m_-4964139221549567676Apple-converted-space"> </span><br><div class="m_-4964139221549567676gmail_signature" data-smartmail="gmail_signature">-QM<br>Quantum Mechanics: The dreams stuff is made of</div></div></div></div><span id="m_-4964139221549567676cid:B9561A20-AD5F-4679-81D3-E4F066833E1F"><Screen Shot 2018-01-30 at 16.19.05.png></span><span id="m_-4964139221549567676cid:6FDB0A9C-92B0-48B0-90B8-773558A09E4E"><Screen Shot 2018-01-30 at 16.20.46.png></span><span style="font-family:Verdana;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;float:none;display:inline!important">_________________<wbr>______________________________</span><span class=""><br style="font-family:Verdana;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px"><span style="font-family:Verdana;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;float:none;display:inline!important">code-quality mailing list</span><br style="font-family:Verdana;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px"><a href="mailto:code-quality@python.org" style="font-family:Verdana;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px" target="_blank">code-quality@python.org</a><br style="font-family:Verdana;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px"><a href="https://mail.python.org/mailman/listinfo/code-quality" style="font-family:Verdana;font-size:12px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px" target="_blank">https://mail.python.org/<wbr>mailman/listinfo/code-quality</a></span></div></blockquote></div><br></div></div></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature" data-smartmail="gmail_signature">-QM<br>Quantum Mechanics: The dreams stuff is made of</div>
</div>