Add docstring to __init__.py

[robkam]

To try and placate CI - is this really needed here?

[sourcery-ai]

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

[elsiehupp]

@robkam—If you're not sure why a check is failing, you can click on "Details" next to each test, and it should give you some sort of explanation.

The failure here is that the MediaWiki version in the test data is not the expected version. In other words, the site we are testing against updated to a new version of MediaWiki. I'm not sure why, but the expected version number appears to be hardcoded in the following two places:

mediawiki-dump-generator/wikiteam3/dumpgenerator/test/test_config.py

Lines 27 to 35 in a8d2ef0

	def get_config(mediawiki_ver, api=True):
	assert api == True
	if mediawiki_ver == "1.39.6":
	return _new_config_from_parameter(
	[
	"--api",
	"https://testw.fandom.com/api.php",
	]
	)

mediawiki-dump-generator/wikiteam3/dumpgenerator/dump/misc/site_info_test.py

Lines 11 to 17 in 3f7bfd7

	def test_mediawiki_version_match():
	with get_config("1.39.6") as config:
	sess = requests.Session()
	saveSiteInfo(config, sess)
	with open(f"{config.path}/siteinfo.json") as f:
	siteInfoJson = json.load(f)
	assert siteInfoJson["query"]["general"]["generator"] == "MediaWiki 1.39.6"

This code appears to have been added by @sian1468—could you help us understand why the version is hardcoded here? And if possible could you find a way to avoid having it hardcoded? Thanks!

[sian1468]

@elsiehupp

This code appears to have been added by @sian1468—could you help us understand why the version is hardcoded here? And if possible could you find a way to avoid having it hardcoded? Thanks!

The original owner of this code is @NyaMisty from commit f57f50f but from my understanding is code used to check if Mediawiki version from test website is match or not.

In my opinion this code should be removed as it is unnecessary to test this function is working or not.

[robkam]

I was only checking the details for pre-commit.ci - I'll close this PR as the docstring isn't the problem.

[robkam]

I've (rather clumsily) tried to remove the hardcoded version check in #243 but it's not fixed the CI.

[robkam]

For now, I've just updated the version number to get it past the CI.

[robkam]

Trying to not mess up #244

[robkam]

Fixed in #245