Bug: world_api.md docs misuses item/event initialization in example code

[Rooby-Roo]

What happened?

In world api, lines 573-575:

def create_event(self, event: str) -> MyGameItem:
    # while we are at it, we can also add a helper to create events
    return MyGameItem(event, True, None, self.player)

MyGameItem is an instance of the item class and inherits the init from it. To my understanding, the second parameter is meant to be an ItemClassification, not a bool. Folks in the discord believe that this may actually result in an event getting passed up on in generation due to not being progression. Blame says this line in particular is four years old.

What were the expected results?

Maybe something like this?

def create_event(self, event: str) -> MyGameItem:
    # while we are at it, we can also add a helper to create events
    return MyGameItem(event, ItemClassification.progression, None, self.player)

Lots of ways to handle it though.

Software

Website

[qwint]

#4596

[Berserker66]

I still believe we should figure out a way to set up doctests for github.
Though the doc is in need of plenty of fixing to get that to pass: