Modified configuration page of user guide to include init-hook description

[JessJohn0]

Type of Changes

	Type
✓	📜 Docs

Description

Updates the configuration section of the user guide with information on configuring an init-hook.
For example, if a user needs to set an alternative site-packages path.

Closes #9974

[DanielNoord]

I'd love for this to be based on the in-code documentation of init-hook just like we automatically generate the documentation for all the other configuration options.

Did you consider looking into such a solution?

[JessJohn0]

Ah ok. I now see that the pylint_options.py file is pulling the options for the checkers/extensions from base_options.py. I'm not sure what the best way to pull in just the information for init-hook for the configuration page would be? Unless we were wanting to generate a separate page for the run options. This is my first time contributing and I think this may be a bigger change than I realized.

[Pierre-Sassoulas]

I think Daniel meant that the modification should be done here:

pylint/pylint/lint/base_options.py

Lines 456 to 463 in cb12577

	"init-hook",
	{
	"action": _DoNothingAction,
	"kwargs": {},
	"help": "Python code to execute, usually for sys.path "
	"manipulation such as pygtk.require().",
	},
	),

Probably not using markdown or rst formatting, so maybe a modification / simplification of the current text is in order too ?

[DanielNoord]

No I think @JessJohn0 is right and this is basically #6938 but then worded for a single option.

It would be better to solve #6938 instead of making individual pages/solutions for each option.

[Pierre-Sassoulas]

Ha, right, my bad. Definitely not a "good first issue" then. What should we do with the current modification ?

[JessJohn0]

That makes sense to me. #6938 looks to be more than I can handle currently. Thank you for your help!