Hi Quantum Mechanic,

Web Search
-------------
I went back and checked a Google search and a Duck Duck Go search on "pylint".

- On Duck Duck Go, https://www.pylint.org <https://www.pylint.org/> and 
https://pylint.readthedocs.io/en/latest/ 
<https://pylint.readthedocs.io/en/latest/> are the first two hits.
- On Google, https://www.pylint.org <https://www.pylint.org/> and 
https://pypi.python.org/pypi/pylint <https://pypi.python.org/pypi/pylint> are 
the first two hits.

For a "pylint pylintrc" search:

- On Duck Duck Go, the website and v2.0 ReadTheDocs page are in the top four 
hits.
- On Google, the v1.6.5 ReadThe Docs page and the GitHub repo are in the top 
two hits.

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. 

ReadTheDocs Search
-----------------------
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.

There is an open issue on the  GitHub repo: 
https://github.com/PyCQA/pylint/issues/1600 
<https://github.com/PyCQA/pylint/issues/1600>

Next actions
--------------

I've added this summary to the open issue: 
https://github.com/PyCQA/pylint/issues/1600#issuecomment-361977477 
<https://github.com/PyCQA/pylint/issues/1600#issuecomment-361977477>

Perhaps labeling this doc issue as Help Wanted as well would be useful.

Regards,

Carol

> On Jan 30, 2018, at 8:46 AM, Quantum Mechanic 
> <quantum.mechanic.1...@gmail.com> wrote:
> 
> Hi,
> 
> I'm sorry I riled everyone up. My apologies. 
> 
> === Trying to reproduce ===
> Getting back to this today, I'm not sent to readthedocs.org 
> <http://readthedocs.org/>. I'll chalk that up to the interwebz demons 
> fiddling around (could be anywhere between my $work, Google, and your end, 
> including various intermediaries).
> 
> Now, back to the next problem. There doesn't seem to be any documentation on 
> the fields in .pylintrc. I'm specifically looking for init-hook help. 
> 
> 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.
> 
> 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, pylint --help 
> 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.)
> 
> === Problem 1 ===
> Search not helpful
> ===============
> 
> 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:
> 
> The first link goes to 
> http://docs.pylint.org/en/latest/user_guide/run.html?highlight=init-hook 
> <http://docs.pylint.org/en/latest/user_guide/run.html?highlight=init-hook>, 
> which looks like this:
> 
> ...which I had before.
> 
> === Problem 2 ===
> Command line help not online
> ===============
> 
> 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.)
> 
> === Problem 3 ===
> How to include multiline code in .pylintrc file in the init-hook section.
> ===============
> 
> This doesn't seem to be covered anywhere in the docs, but is an obvious use 
> case.
> 
> 
> 
> On Fri, Jan 26, 2018 at 12:05 PM, Quantum Mechanic 
> <quantum.mechanic.1...@gmail.com 
> <mailto:quantum.mechanic.1...@gmail.com>>wrote:
> Googling for "pylint pylintrc" gives me the first hit as 
> https://docs.pylint.org/en/1.6.0/run.html 
> <https://docs.pylint.org/en/1.6.0/run.html>.
> 
> This lands me on https://docs.pylint.org/en/1.6.0/run.html 
> <https://docs.pylint.org/en/1.6.0/run.html>, asking me to login. I have a 
> login, and clicking "Login" sends me to https://readthedocs.org/dashboard/ 
> <https://readthedocs.org/dashboard/>, spoiling the google search.
> 
> 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.
> 
> Poking around until I find a search box at 
> https://pylint.readthedocs.io/en/latest/ 
> <https://pylint.readthedocs.io/en/latest/>, I type in "pylintrc", which 
> returns the *same bloody page* (OK, yes, it has this helpful bit: 
> https://pylint.readthedocs.io/en/latest/?highlight=pylintrc 
> <https://pylint.readthedocs.io/en/latest/?highlight=pylintrc>, which does 
> exactly...nothing.)
> 
> So I'm stuck trolling around in the full docs there. Instead, I should just 
> pull down the source code, and do my own grep -r.
> 
> I feel like I've been violated.
> 
> -- 
> -QM
> Quantum Mechanics: The dreams stuff is made of
> 
> 
> 
> -- 
> -QM
> Quantum Mechanics: The dreams stuff is made of
> <Screen Shot 2018-01-30 at 16.19.05.png><Screen Shot 2018-01-30 at 
> 16.20.46.png>_______________________________________________
> code-quality mailing list
> code-quality@python.org <mailto:code-quality@python.org>
> https://mail.python.org/mailman/listinfo/code-quality 
> <https://mail.python.org/mailman/listinfo/code-quality>
_______________________________________________
code-quality mailing list
code-quality@python.org
https://mail.python.org/mailman/listinfo/code-quality

Reply via email to